Expand all

Integrating with the API

Before integrating with the Dynamic Content service API, please read the integration guide. It describes the request and response formats, HTTP status codes and provides useful strategies for integrating with the API.

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

Snippet auth-rules not found for operation::get-root

Example request

GET /v2/content HTTP/1.1
Accept: application/hal+json
Content-Type: application/json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 490

{
  "_links" : {
    "hubs" : {
      "href" : "https://api.amplience.net/v2/content/hubs{?page,size,sort}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content"
    },
    "admin" : {
      "href" : "https://api.amplience.net/v2/content/admin"
    },
    "localization" : {
      "href" : "https://api.amplience.net/v2/content/localization"
    },
    "management" : {
      "href" : "https://api.amplience.net/v2/content/manage"
    }
  }
}

Getting root returns a basic list of links to start operating with the Dynamic Content API.

Information

A small set of endpoints exists solely to provide information about the Dynamic Content Service itself.

Supported Localization Settings

Provides the master list of all currently supported ISO 639-1 language codes and ISO 3166 country codes.

Auth rules

Required Functional Permissions:
  • none

Example request

GET /v2/content/localization HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2754

{
  "languages" : [ "aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bh", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fl", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu" ],
  "countries" : [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization"
    }
  }
}

Hubs

Hubs are containers for multiple repositories including media, content, content types.

Creating a new Hub

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:HUB:CREATE

Example request

POST /v2/content/hubs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 312

{
  "name" : "anya-finn",
  "label" : "Anya Finn",
  "description" : "Content for anyafinn.com",
  "settings" : {
    "publishing" : {
      "platforms" : {
        "amplience_dam" : {
          "API_KEY" : "KEY",
          "API_SECRET" : "SECRET",
          "endpoint" : "Endpoint"
        }
      }
    }
  }
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:26 GMT
Location: https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4398

{
  "id" : "5d722cd246e0fb03670c9713",
  "name" : "anya-finn",
  "label" : "Anya Finn",
  "description" : "Content for anyafinn.com",
  "status" : "ACTIVE",
  "settings" : {
    "virtualStagingEnvironment" : {
      "hostname" : ""
    },
    "previewVirtualStagingEnvironment" : {
      "hostname" : ""
    },
    "applications" : [ ],
    "devices" : [ {
      "name" : "Desktop",
      "width" : 1024,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Tablet",
      "width" : 640,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Mobile",
      "width" : 320,
      "height" : 512,
      "orientate" : false
    } ],
    "publishing" : {
      "platforms" : {
        "amplience_dam" : {
          "API_KEY" : "KEY",
          "endpoint" : "Endpoint"
        }
      }
    },
    "localization" : {
      "locales" : [ ]
    }
  },
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:26.056Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:26.056Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd246e0fb03670c9713/workflow-states{?page,size,sort}",
      "templated" : true
    }
  }
}

Listing Hubs

Auth rules

Required Functional Permissions:
  • none

Example request

GET /v2/content/hubs HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 15145

{
  "_embedded" : {
    "hubs" : [ {
      "id" : "5d722cd046e0fb03670c9387",
      "name" : "hub1",
      "label" : "Anya Finn",
      "description" : "Content for anyafinn.com",
      "status" : "ACTIVE",
      "settings" : {
        "virtualStagingEnvironment" : {
          "hostname" : ""
        },
        "previewVirtualStagingEnvironment" : {
          "hostname" : ""
        },
        "applications" : [ ],
        "devices" : [ {
          "name" : "Desktop",
          "width" : 1024,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Tablet",
          "width" : 640,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Mobile",
          "width" : 320,
          "height" : 512,
          "orientate" : false
        } ],
        "publishing" : {
          "platforms" : {
            "amplience_dam" : {
              "API_KEY" : "KEY",
              "endpoint" : "Endpoint"
            }
          }
        },
        "localization" : {
          "locales" : [ ]
        }
      },
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:24.550Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:24.550Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9387/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722cd046e0fb03670c9389",
      "name" : "hub2",
      "label" : "Anya Finn",
      "description" : "Content for anyafinn.com",
      "status" : "ACTIVE",
      "settings" : {
        "virtualStagingEnvironment" : {
          "hostname" : ""
        },
        "previewVirtualStagingEnvironment" : {
          "hostname" : ""
        },
        "applications" : [ ],
        "devices" : [ {
          "name" : "Desktop",
          "width" : 1024,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Tablet",
          "width" : 640,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Mobile",
          "width" : 320,
          "height" : 512,
          "orientate" : false
        } ],
        "publishing" : {
          "platforms" : {
            "amplience_dam" : {
              "API_KEY" : "KEY",
              "endpoint" : "Endpoint"
            }
          }
        },
        "localization" : {
          "locales" : [ ]
        }
      },
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:24.585Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:24.585Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c9389/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722cd046e0fb03670c938b",
      "name" : "hub3",
      "label" : "Anya Finn",
      "description" : "Content for anyafinn.com",
      "status" : "ACTIVE",
      "settings" : {
        "virtualStagingEnvironment" : {
          "hostname" : ""
        },
        "previewVirtualStagingEnvironment" : {
          "hostname" : ""
        },
        "applications" : [ ],
        "devices" : [ {
          "name" : "Desktop",
          "width" : 1024,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Tablet",
          "width" : 640,
          "height" : 768,
          "orientate" : false
        }, {
          "name" : "Mobile",
          "width" : 320,
          "height" : 512,
          "orientate" : false
        } ],
        "publishing" : {
          "platforms" : {
            "amplience_dam" : {
              "API_KEY" : "KEY",
              "endpoint" : "Endpoint"
            }
          }
        },
        "localization" : {
          "locales" : [ ]
        }
      },
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:24.623Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:24.623Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cd046e0fb03670c938b/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d5746e0fb03670cc383 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:56:39 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4849

{
  "id" : "5d722d5746e0fb03670cc383",
  "name" : "hub",
  "label" : "Anya Finn",
  "description" : "Content for anyafinn.com",
  "status" : "ACTIVE",
  "settings" : {
    "virtualStagingEnvironment" : {
      "hostname" : ""
    },
    "previewVirtualStagingEnvironment" : {
      "hostname" : ""
    },
    "applications" : [ ],
    "devices" : [ {
      "name" : "Desktop",
      "width" : 1024,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Tablet",
      "width" : 640,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Mobile",
      "width" : 320,
      "height" : 512,
      "orientate" : false
    } ],
    "publishing" : {
      "platforms" : {
        "amplience_dam" : {
          "API_KEY" : "KEY",
          "endpoint" : "Endpoint"
        }
      }
    },
    "localization" : {
      "locales" : [ ]
    }
  },
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:56:39.205Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:56:39.205Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    },
    "webhooks" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/webhooks"
    },
    "integrations" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/integrations{?page,size,sort}",
      "templated" : true
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc383/workflow-states{?page,size,sort}",
      "templated" : true
    }
  }
}

Updating a Hub

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:HUB:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request

PATCH /v2/content/hubs/5d722cd146e0fb03670c9525 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 101

{
  "name" : "anya-finn",
  "label" : "Anya Finn",
  "description" : "New Content for anyafinn.com"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:25 GMT
Location: https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4402

{
  "id" : "5d722cd146e0fb03670c9525",
  "name" : "anya-finn",
  "label" : "Anya Finn",
  "description" : "New Content for anyafinn.com",
  "status" : "ACTIVE",
  "settings" : {
    "virtualStagingEnvironment" : {
      "hostname" : ""
    },
    "previewVirtualStagingEnvironment" : {
      "hostname" : ""
    },
    "applications" : [ ],
    "devices" : [ {
      "name" : "Desktop",
      "width" : 1024,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Tablet",
      "width" : 640,
      "height" : 768,
      "orientate" : false
    }, {
      "name" : "Mobile",
      "width" : 320,
      "height" : 512,
      "orientate" : false
    } ],
    "publishing" : {
      "platforms" : {
        "amplience_dam" : {
          "API_KEY" : "KEY",
          "endpoint" : "Endpoint"
        }
      }
    },
    "localization" : {
      "locales" : [ ]
    }
  },
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:25.443Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:25.471Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cd146e0fb03670c9525/workflow-states{?page,size,sort}",
      "templated" : true
    }
  }
}

Updating settings

To update an Hub’s settings, you need to execute a PATCH to the Hub’s 'update-settings' HAL link.

Example: Update all of the devices settings:

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:HUB:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request
PATCH /v2/content/hubs/5d722d5646e0fb03670cc32b/settings HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 125

{
  "devices" : [ {
    "name" : "Fancy New Device",
    "width" : 2048,
    "height" : 1024,
    "orientate" : false
  } ]
}
Example response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc32b

Example: Update the Virtual Staging Environment settings:

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:HUB:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request
PATCH /v2/content/hubs/5d722d5646e0fb03670cc32d/settings HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 85

{
  "virtualStagingEnvironment" : {
    "hostname" : "subdomain.testdomain.com"
  }
}
Example response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc32d

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

POST /v2/content/hubs/5d722cd246e0fb03670c97b7/share HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 80

{
  "user" : "alice",
  "additionalPermissions" : [ "READ", "EDIT", "DELETE" ]
}

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Localization

See Localization for info on how to setup your Hub for Content Item level localization.

Content Types

Register a Content Type with a Hub

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5d722cc746e0fb03670c8acb/content-types HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 537

{
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "settings" : {
    "label" : "myLabel",
    "icons" : [ {
      "size" : 256,
      "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
    } ],
    "visualizations" : [ {
      "label" : "Desktop Website",
      "templatedUri" : "http://website",
      "default" : true
    }, {
      "label" : "Mobile Website",
      "templatedUri" : "http://mobile.website",
      "default" : false
    } ]
  }
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8ace
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1124

{
  "id" : "5d722cc746e0fb03670c8ace",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "settings" : {
    "label" : "myLabel",
    "icons" : [ {
      "size" : 256,
      "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
    } ],
    "visualizations" : [ {
      "label" : "Desktop Website",
      "templatedUri" : "http://website",
      "default" : true
    }, {
      "label" : "Mobile Website",
      "templatedUri" : "http://mobile.website",
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8ace"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8ace"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8ace/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8ace/schema"
    }
  }
}

Assign a Content Type to a Repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

POST /v2/content/content-repositories/5d722d4446e0fb03670cad16/content-types HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "contentTypeId" : "5d722d4446e0fb03670cad15"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3288

{
  "id" : "5d722d4446e0fb03670cad16",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ {
    "hubContentTypeId" : "5d722d4446e0fb03670cad15",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
  } ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cad12"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cad12/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cad12/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cad16/localization-group/locales"
    }
  }
}

Unassign a Content Type from a Repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

DELETE /v2/content/content-repositories/5d722d4446e0fb03670cac16/content-types/5d722d4446e0fb03670cac15 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

{
  "id" : "5d722d4446e0fb03670cac16",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cac12"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cac12/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cac12/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cac16/localization-group/locales"
    }
  }
}

Listing Content Types

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722cc546e0fb03670c8971/content-types HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4490

{
  "_embedded" : {
    "content-types" : [ {
      "id" : "5d722cc546e0fb03670c8974",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "settings" : {
        "label" : "myLabel",
        "icons" : [ {
          "size" : 256,
          "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
        } ],
        "visualizations" : [ {
          "label" : "Desktop Website",
          "templatedUri" : "http://website",
          "default" : true
        }, {
          "label" : "Mobile Website",
          "templatedUri" : "http://mobile.website",
          "default" : false
        } ]
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8974"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8974"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8974/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8974/schema"
        }
      }
    }, {
      "id" : "5d722cc546e0fb03670c8976",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/schema_schema/draft-04.json",
      "settings" : {
        "label" : "myLabel",
        "icons" : [ {
          "size" : 256,
          "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
        } ],
        "visualizations" : [ {
          "label" : "Desktop Website",
          "templatedUri" : "http://website",
          "default" : true
        }, {
          "label" : "Mobile Website",
          "templatedUri" : "http://mobile.website",
          "default" : false
        } ]
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8976"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8976"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8976/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8976/schema"
        }
      }
    }, {
      "id" : "5d722cc546e0fb03670c8978",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/schema_schema/cms-schema-v1.json",
      "settings" : {
        "label" : "myLabel",
        "icons" : [ {
          "size" : 256,
          "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
        } ],
        "visualizations" : [ {
          "label" : "Desktop Website",
          "templatedUri" : "http://website",
          "default" : true
        }, {
          "label" : "Mobile Website",
          "templatedUri" : "http://mobile.website",
          "default" : false
        } ]
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8978"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8978"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8978/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c8978/schema"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cc546e0fb03670c8971/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cc546e0fb03670c8971/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cc546e0fb03670c8971/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cc546e0fb03670c8971/content-types/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get a Content Type

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-types/5d722cc546e0fb03670c891f HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1124

{
  "id" : "5d722cc546e0fb03670c891f",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "settings" : {
    "label" : "myLabel",
    "icons" : [ {
      "size" : 256,
      "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
    } ],
    "visualizations" : [ {
      "label" : "Desktop Website",
      "templatedUri" : "http://website",
      "default" : true
    }, {
      "label" : "Mobile Website",
      "templatedUri" : "http://mobile.website",
      "default" : false
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c891f"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c891f"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c891f/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc546e0fb03670c891f/schema"
    }
  }
}

Update a Content Type

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/content-types/5d722cc446e0fb03670c88ca HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 345

{
  "settings" : {
    "label" : "myLabelUpdated",
    "icons" : [ {
      "size" : 256,
      "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
    } ],
    "visualizations" : [ {
      "label" : "Desktop Website",
      "templatedUri" : "http://website",
      "default" : true
    } ]
  }
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/content-types/5d722cc446e0fb03670c88ca
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1016

{
  "id" : "5d722cc446e0fb03670c88ca",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "settings" : {
    "label" : "myLabelUpdated",
    "icons" : [ {
      "size" : 256,
      "url" : "http://apps.dev-artifacts.adis.ws/cms-icons/develop/v0.4.0/256/ca-types-grid-mixedmedia.png"
    } ],
    "visualizations" : [ {
      "label" : "Desktop Website",
      "templatedUri" : "http://website",
      "default" : true
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc446e0fb03670c88ca"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc446e0fb03670c88ca"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc446e0fb03670c88ca/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc446e0fb03670c88ca/schema"
    }
  }
}

Get a Content Type Schema

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-types/5d722cc746e0fb03670c8a79/schema HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1739

{
  "hubId" : "5d722cc646e0fb03670c8a76",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "cachedSchema" : {
    "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
    "id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "title" : "Inline content type",
    "description" : "Example of an inline content nested content type",
    "allOf" : [ {
      "$ref" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content"
    } ],
    "type" : "object",
    "properties" : {
      "inlineExample" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "field1" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "field1" ]
      },
      "internalRefExample" : {
        "$ref" : "#/definitions/mapEntry"
      },
      "externalRefExample" : {
        "$ref" : "http://deliver.bigcontent.io/schema/empty-type.json#"
      },
      "arrayExample" : {
        "type" : "array",
        "title" : "this is a title",
        "items" : {
          "$ref" : "#/definitions/mapEntry"
        }
      }
    },
    "definitions" : {
      "mapEntry" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "key" : {
            "type" : "string",
            "title" : "this is a title"
          },
          "value" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "key", "value" ]
      }
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc746e0fb03670c8a79/schema"
    }
  }
}

Update a Content Type Schema

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/content-types/5d722cc646e0fb03670c8a22/schema HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 3

{ }

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1739

{
  "hubId" : "5d722cc646e0fb03670c8a1f",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "cachedSchema" : {
    "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
    "id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "title" : "Newly Updated title",
    "description" : "Example of an inline content nested content type",
    "allOf" : [ {
      "$ref" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content"
    } ],
    "type" : "object",
    "properties" : {
      "inlineExample" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "field1" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "field1" ]
      },
      "internalRefExample" : {
        "$ref" : "#/definitions/mapEntry"
      },
      "externalRefExample" : {
        "$ref" : "http://deliver.bigcontent.io/schema/empty-type.json#"
      },
      "arrayExample" : {
        "type" : "array",
        "title" : "this is a title",
        "items" : {
          "$ref" : "#/definitions/mapEntry"
        }
      }
    },
    "definitions" : {
      "mapEntry" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "key" : {
            "type" : "string",
            "title" : "this is a title"
          },
          "value" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "key", "value" ]
      }
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5d722cc646e0fb03670c8a22/schema"
    }
  }
}

Content Repositories

A service that registers content types which are referenced in the content type repository for use with the Amplience Content Management System.

Creating a new Content Repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:CREATE

Required ACLs:
  • Hub - READ

  • Hub - CREATE_REPOSITORY

Example request

POST /v2/content/hubs/5d722cce46e0fb03670c8f96/content-repositories HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 55

{
  "name" : "inspiration",
  "label" : "Inspiration"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

{
  "id" : "5d722cce46e0fb03670c8f97",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c8f96"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c8f96/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c8f96/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c8f97/localization-group/locales"
    }
  }
}

Listing Content Repositories

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722cce46e0fb03670c903c/content-repositories HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 11157

{
  "_embedded" : {
    "content-repositories" : [ {
      "id" : "5d722cce46e0fb03670c903d",
      "name" : "repo1",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/features?feature={feature}",
          "templated" : true
        },
        "update-content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-items"
        },
        "set-item-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903d/localization-group/locales"
        }
      }
    }, {
      "id" : "5d722cce46e0fb03670c903e",
      "name" : "repo2",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/features?feature={feature}",
          "templated" : true
        },
        "update-content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-items"
        },
        "set-item-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903e/localization-group/locales"
        }
      }
    }, {
      "id" : "5d722cce46e0fb03670c903f",
      "name" : "repo3",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/features?feature={feature}",
          "templated" : true
        },
        "update-content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-items"
        },
        "set-item-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c903f/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-repositories?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-repositories?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-repositories?page=0&size=20"
    },
    "search:findByFeaturesContaining" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c903c/content-repositories/search/findByFeaturesContaining?feature={feature}{&page,size,sort}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Content Repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722cce46e0fb03670c9092 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

{
  "id" : "5d722cce46e0fb03670c9092",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c9091"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c9091/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722cce46e0fb03670c9091/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cce46e0fb03670c9092/localization-group/locales"
    }
  }
}

Update Content Repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

PATCH /v2/content/content-repositories/5d722ccf46e0fb03670c90e5 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 69

{
  "name" : "inspiration",
  "label" : "updated inspiration label"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3158

{
  "id" : "5d722ccf46e0fb03670c90e5",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ccf46e0fb03670c90e4"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ccf46e0fb03670c90e4/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ccf46e0fb03670c90e4/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c90e5/localization-group/locales"
    }
  }
}

Add feature flag to repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

POST /v2/content/content-repositories/5d722d4546e0fb03670cadc6/features?feature=slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

feature=slots

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Remove feature flag from repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

DELETE /v2/content/content-repositories/5d722d4546e0fb03670cadcb/features?feature=slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Find repositories with feature flags

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d4546e0fb03670cadc1/content-repositories/search/findByFeaturesContaining?feature=slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4190

{
  "_embedded" : {
    "content-repositories" : [ {
      "id" : "5d722d4546e0fb03670cadc3",
      "name" : "slot-repo-0",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ "slots" ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/features?feature={feature}",
          "templated" : true
        },
        "update-content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-items"
        },
        "set-item-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cadc3/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4546e0fb03670cadc1/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Share Content Repository

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • ContentRepository - SHARE

Example request

POST /v2/content/content-repositories/5d722cce46e0fb03670c8f44/share HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 83

{
  "user" : "someuser",
  "additionalPermissions" : [ "READ", "EDIT", "DELETE" ]
}

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Localization

See Localization for info on how to setup your Content Repository for Content Item level localization.

Content Items

Content Items are instances of content created from a content type.

Creating a new Content Item

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5d722cca46e0fb03670c8c80/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 345

{
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label" : "Banner Ad Homepage",
  "folderId" : "5d722cca46e0fb03670c8c84",
  "locale" : "en"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:18 GMT
Location: https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "7805d62a-5319-46a5-89ce-ef26e5a77017",
  "folderId" : "5d722cca46e0fb03670c8c84",
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "locale" : "en",
  "createdDate" : "2019-09-06T09:54:18.598Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:18.598Z",
  "deliveryId" : "7805d62a-5319-46a5-89ce-ef26e5a77017",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7805d62a-5319-46a5-89ce-ef26e5a77017"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cca46e0fb03670c8c80"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7805d62a-5319-46a5-89ce-ef26e5a77017",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cca46e0fb03670c8c84"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7805d62a-5319-46a5-89ce-ef26e5a77017{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7805d62a-5319-46a5-89ce-ef26e5a77017/workflow"
    }
  }
}

Get Content Item by Id

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:18 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "6f4b4832-3c5a-4f44-9f4f-edb326a50543",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:18.073Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:18.073Z",
  "deliveryId" : "6f4b4832-3c5a-4f44-9f4f-edb326a50543",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6f4b4832-3c5a-4f44-9f4f-edb326a50543"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cc946e0fb03670c8c29"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6f4b4832-3c5a-4f44-9f4f-edb326a50543",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6f4b4832-3c5a-4f44-9f4f-edb326a50543{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f4b4832-3c5a-4f44-9f4f-edb326a50543/workflow"
    }
  }
}

Update Content Item

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 369

{
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "label" : "Banner Ad Homepage",
  "version" : 1,
  "folderId" : "5d722ccb46e0fb03670c8cdd"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:19 GMT
Location: https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "1f5c30cd-cf1a-4a80-b14b-a31769c63547",
  "folderId" : "5d722ccb46e0fb03670c8cdd",
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "version" : 2,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:19.047Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:19.095Z",
  "deliveryId" : "1f5c30cd-cf1a-4a80-b14b-a31769c63547",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1f5c30cd-cf1a-4a80-b14b-a31769c63547"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cca46e0fb03670c8cd9"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1f5c30cd-cf1a-4a80-b14b-a31769c63547",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccb46e0fb03670c8cdd"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1f5c30cd-cf1a-4a80-b14b-a31769c63547{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f5c30cd-cf1a-4a80-b14b-a31769c63547/workflow"
    }
  }
}

Copy Content Item

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5d722d2646e0fb03670ca7bb/content-items?sourceContentItemId=e01af820-0ef3-4c42-b250-776905aeecac HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 67

{
  "name" : "new-name",
  "label" : "New Label",
  "version" : 1
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:50 GMT
Location: https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "07368507-7aef-4d8b-95e6-03806c50e708",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "new-name",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "New Label",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:50.328Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:50.328Z",
  "deliveryId" : "07368507-7aef-4d8b-95e6-03806c50e708",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=07368507-7aef-4d8b-95e6-03806c50e708"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2646e0fb03670ca7bb"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=07368507-7aef-4d8b-95e6-03806c50e708",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=07368507-7aef-4d8b-95e6-03806c50e708{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/07368507-7aef-4d8b-95e6-03806c50e708/workflow"
    }
  }
}

If you want to specify the folder to copy the content item into use the following request format:

Auth rules: Source

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Auth rules: Destination

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5d722d2646e0fb03670ca7c3/content-items?sourceContentItemId=6bde0b71-9498-4e3b-8297-3a5114d83bd4 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 117

{
  "name" : "new-name",
  "label" : "new-label",
  "version" : "latest",
  "folderId" : "5d722d2646e0fb03670ca7c9"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:50 GMT
Location: https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "79dc3d20-5e99-4ed2-be18-5c254f4a56aa",
  "folderId" : "5d722d2646e0fb03670ca7c9",
  "body" : {
    "_meta" : {
      "name" : "new-name",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "new-label",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:50.536Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:50.536Z",
  "deliveryId" : "79dc3d20-5e99-4ed2-be18-5c254f4a56aa",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=79dc3d20-5e99-4ed2-be18-5c254f4a56aa"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2646e0fb03670ca7c3"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=79dc3d20-5e99-4ed2-be18-5c254f4a56aa",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722d2646e0fb03670ca7c9"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=79dc3d20-5e99-4ed2-be18-5c254f4a56aa{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/79dc3d20-5e99-4ed2-be18-5c254f4a56aa/workflow"
    }
  }
}

Archive Content Item

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:DELETE

Required ACLs:
  • Hub - READ

  • ContentRepository - DELETE_CONTENT

Example request

POST /v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/archive HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 19

{
  "version" : 1
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3908

{
  "id" : "7bb0458b-674c-43b4-8695-ceb011a765c0",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ARCHIVED",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:51.910Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:51.929Z",
  "deliveryId" : "7bb0458b-674c-43b4-8695-ceb011a765c0",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7bb0458b-674c-43b4-8695-ceb011a765c0"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2746e0fb03670ca8d6"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7bb0458b-674c-43b4-8695-ceb011a765c0",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7bb0458b-674c-43b4-8695-ceb011a765c0{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7bb0458b-674c-43b4-8695-ceb011a765c0/workflow"
    }
  }
}

Unarchive Content Item

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

POST /v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/unarchive HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 19

{
  "version" : 1
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "317e2177-7b80-48b3-82cd-119a008ebcc4",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2017-06-05T04:03:03.000Z",
  "deliveryId" : "317e2177-7b80-48b3-82cd-119a008ebcc4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=317e2177-7b80-48b3-82cd-119a008ebcc4"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2746e0fb03670ca87d"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=317e2177-7b80-48b3-82cd-119a008ebcc4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=317e2177-7b80-48b3-82cd-119a008ebcc4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/317e2177-7b80-48b3-82cd-119a008ebcc4/workflow"
    }
  }
}

Update multiple Content Items

The following endpoint enables users to update up to 100 content items in a single request.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 842

[ {
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "label" : "Banner Ad Homepage",
  "version" : 1,
  "folderId" : "5d722ccc46e0fb03670c8de8",
  "id" : "581c19f8-8282-4c4d-add6-cc2f913b1f98"
}, {
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "label" : "Banner Ad Homepage",
  "version" : 1,
  "folderId" : "5d722ccc46e0fb03670c8de8",
  "id" : "a96308b1-3a19-440d-8f79-50653b1fc326"
} ]

Example response

HTTP/1.1 207 Multi-Status
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 310

{
  "results" : [ {
    "id" : "581c19f8-8282-4c4d-add6-cc2f913b1f98",
    "status" : 200,
    "code" : "SUCCESS",
    "level" : "INFO",
    "message" : null
  }, {
    "id" : "a96308b1-3a19-440d-8f79-50653b1fc326",
    "status" : 200,
    "code" : "SUCCESS",
    "level" : "INFO",
    "message" : null
  } ]
}

Listing Content Items

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722ccb46e0fb03670c8d32/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 13955

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "54433f21-8359-4796-92d2-f47d00d44865",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item3",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:19.588Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:19.588Z",
      "deliveryId" : "54433f21-8359-4796-92d2-f47d00d44865",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=54433f21-8359-4796-92d2-f47d00d44865"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=54433f21-8359-4796-92d2-f47d00d44865",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=54433f21-8359-4796-92d2-f47d00d44865{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54433f21-8359-4796-92d2-f47d00d44865/workflow"
        }
      }
    }, {
      "id" : "742567d7-293f-4074-ac18-4c7c9c02d3a7",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item2",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:19.549Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:19.549Z",
      "deliveryId" : "742567d7-293f-4074-ac18-4c7c9c02d3a7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=742567d7-293f-4074-ac18-4c7c9c02d3a7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=742567d7-293f-4074-ac18-4c7c9c02d3a7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=742567d7-293f-4074-ac18-4c7c9c02d3a7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/742567d7-293f-4074-ac18-4c7c9c02d3a7/workflow"
        }
      }
    }, {
      "id" : "7279e9f6-46e2-4e2c-b7a9-af07fa14fd72",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item1",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:19.509Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:19.509Z",
      "deliveryId" : "7279e9f6-46e2-4e2c-b7a9-af07fa14fd72",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7279e9f6-46e2-4e2c-b7a9-af07fa14fd72"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7279e9f6-46e2-4e2c-b7a9-af07fa14fd72",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7279e9f6-46e2-4e2c-b7a9-af07fa14fd72{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7279e9f6-46e2-4e2c-b7a9-af07fa14fd72/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d32/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Listing Content Items excluding body

In order to exclude the body from the response, specify ?projection=basic in the request path.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722d2446e0fb03670ca6ac/content-items?projection=basic HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4972

{
  "_embedded" : {
    "content-items" : [ {
      "createdBy" : "user",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "label" : "Banner Ad Homepage",
      "deliveryId" : "7b033b6e-9216-44f4-baba-ff91cd5e40a2",
      "folderId" : null,
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "locale" : "en",
      "status" : "ACTIVE",
      "id" : "7b033b6e-9216-44f4-baba-ff91cd5e40a2",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7b033b6e-9216-44f4-baba-ff91cd5e40a2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2446e0fb03670ca6ac"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7b033b6e-9216-44f4-baba-ff91cd5e40a2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7b033b6e-9216-44f4-baba-ff91cd5e40a2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7b033b6e-9216-44f4-baba-ff91cd5e40a2/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2446e0fb03670ca6ac/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2446e0fb03670ca6ac/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2446e0fb03670ca6ac/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2446e0fb03670ca6ac/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Listing Content Items with sorting

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722ccb46e0fb03670c8d8b/content-items?sort=label%2Casc HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 13906

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "d723931c-0eaf-4819-839c-17f24bbcde1d",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item1",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Aardvark",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:20.083Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:20.083Z",
      "deliveryId" : "d723931c-0eaf-4819-839c-17f24bbcde1d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d723931c-0eaf-4819-839c-17f24bbcde1d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d723931c-0eaf-4819-839c-17f24bbcde1d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d723931c-0eaf-4819-839c-17f24bbcde1d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d723931c-0eaf-4819-839c-17f24bbcde1d/workflow"
        }
      }
    }, {
      "id" : "a592063f-dd9d-4c51-ba49-0666ddc12fcb",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item2",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Betelgeuse",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:20.115Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:20.115Z",
      "deliveryId" : "a592063f-dd9d-4c51-ba49-0666ddc12fcb",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a592063f-dd9d-4c51-ba49-0666ddc12fcb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a592063f-dd9d-4c51-ba49-0666ddc12fcb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a592063f-dd9d-4c51-ba49-0666ddc12fcb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a592063f-dd9d-4c51-ba49-0666ddc12fcb/workflow"
        }
      }
    }, {
      "id" : "d6a21137-a322-4aac-a78e-f2dd2a183d85",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting",
        "meta" : {
          "name" : "item3",
          "type" : "http://example.com/schema.json"
        }
      },
      "version" : 1,
      "label" : "Cardamon",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:20.148Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:20.148Z",
      "deliveryId" : "d6a21137-a322-4aac-a78e-f2dd2a183d85",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d6a21137-a322-4aac-a78e-f2dd2a183d85"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d6a21137-a322-4aac-a78e-f2dd2a183d85",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d6a21137-a322-4aac-a78e-f2dd2a183d85{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d6a21137-a322-4aac-a78e-f2dd2a183d85/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccb46e0fb03670c8d8b/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Sort options are:

Table 1. Content Item sorting
Field Sort

label

sort=label,asc

sort=label,desc

content type

sort=body._meta.schema,asc

sort=body._meta.schema,desc

created date

sort=createdDate,asc

sort=createdDate,desc

last modified date

sort=lastModifiedDate,asc

sort=lastModifiedDate,desc

Listing Content Items filtered by folder ID

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722d2946e0fb03670caa55/content-items?folderId=5d722d2946e0fb03670caa59 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5344

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "94b8f452-2bd1-426a-82a4-5a39ef859edf",
      "folderId" : "5d722d2946e0fb03670caa59",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:53.918Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:53.918Z",
      "deliveryId" : "94b8f452-2bd1-426a-82a4-5a39ef859edf",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=94b8f452-2bd1-426a-82a4-5a39ef859edf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa55"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=94b8f452-2bd1-426a-82a4-5a39ef859edf",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2946e0fb03670caa59"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=94b8f452-2bd1-426a-82a4-5a39ef859edf{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94b8f452-2bd1-426a-82a4-5a39ef859edf/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa55/content-items?folderId=5d722d2946e0fb03670caa59&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa55/content-items?folderId=5d722d2946e0fb03670caa59&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa55/content-items?folderId=5d722d2946e0fb03670caa59&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa55/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Multiple folder IDs can be specified either by providing a comma separated list or multiple folderId query parameters. The following requests are equivalent:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722d2946e0fb03670caa48/content-items?folderId=5d722d2946e0fb03670caa4c,5d722d2946e0fb03670caa4d HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 18646

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "795a8f81-96db-422c-8616-c4a1b7af7aaf",
      "folderId" : "5d722d2946e0fb03670caa4d",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:53.728Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:53.728Z",
      "deliveryId" : "795a8f81-96db-422c-8616-c4a1b7af7aaf",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=795a8f81-96db-422c-8616-c4a1b7af7aaf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=795a8f81-96db-422c-8616-c4a1b7af7aaf",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2946e0fb03670caa4d"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=795a8f81-96db-422c-8616-c4a1b7af7aaf{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/795a8f81-96db-422c-8616-c4a1b7af7aaf/workflow"
        }
      }
    }, {
      "id" : "08ef04db-c1d6-4e17-b525-5a262bb9bf1b",
      "folderId" : "5d722d2946e0fb03670caa4d",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:53.703Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:53.703Z",
      "deliveryId" : "08ef04db-c1d6-4e17-b525-5a262bb9bf1b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=08ef04db-c1d6-4e17-b525-5a262bb9bf1b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=08ef04db-c1d6-4e17-b525-5a262bb9bf1b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2946e0fb03670caa4d"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=08ef04db-c1d6-4e17-b525-5a262bb9bf1b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/08ef04db-c1d6-4e17-b525-5a262bb9bf1b/workflow"
        }
      }
    }, {
      "id" : "3a58b855-43a2-4d6b-8960-08beebf4338a",
      "folderId" : "5d722d2946e0fb03670caa4d",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:53.684Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:53.684Z",
      "deliveryId" : "3a58b855-43a2-4d6b-8960-08beebf4338a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3a58b855-43a2-4d6b-8960-08beebf4338a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3a58b855-43a2-4d6b-8960-08beebf4338a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2946e0fb03670caa4d"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3a58b855-43a2-4d6b-8960-08beebf4338a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a58b855-43a2-4d6b-8960-08beebf4338a/workflow"
        }
      }
    }, {
      "id" : "021a260c-4dfd-4c66-b9a0-0495d7ce3a89",
      "folderId" : "5d722d2946e0fb03670caa4c",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:53.664Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:53.664Z",
      "deliveryId" : "021a260c-4dfd-4c66-b9a0-0495d7ce3a89",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=021a260c-4dfd-4c66-b9a0-0495d7ce3a89"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=021a260c-4dfd-4c66-b9a0-0495d7ce3a89",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2946e0fb03670caa4c"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=021a260c-4dfd-4c66-b9a0-0495d7ce3a89{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/021a260c-4dfd-4c66-b9a0-0495d7ce3a89/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48/content-items?folderId=5d722d2946e0fb03670caa4c,5d722d2946e0fb03670caa4d&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48/content-items?folderId=5d722d2946e0fb03670caa4c,5d722d2946e0fb03670caa4d&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48/content-items?folderId=5d722d2946e0fb03670caa4c,5d722d2946e0fb03670caa4d&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2946e0fb03670caa48/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722d2a46e0fb03670caa62/content-items?folderId=5d722d2a46e0fb03670caa66&folderId=5d722d2a46e0fb03670caa67 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 18673

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "6e9ae7f8-5652-471b-93eb-8ce28ea919e3",
      "folderId" : "5d722d2a46e0fb03670caa67",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.219Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.219Z",
      "deliveryId" : "6e9ae7f8-5652-471b-93eb-8ce28ea919e3",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6e9ae7f8-5652-471b-93eb-8ce28ea919e3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6e9ae7f8-5652-471b-93eb-8ce28ea919e3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa67"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6e9ae7f8-5652-471b-93eb-8ce28ea919e3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e9ae7f8-5652-471b-93eb-8ce28ea919e3/workflow"
        }
      }
    }, {
      "id" : "7c78e3cf-53ea-4470-ac43-ce16438d8757",
      "folderId" : "5d722d2a46e0fb03670caa67",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.199Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.199Z",
      "deliveryId" : "7c78e3cf-53ea-4470-ac43-ce16438d8757",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7c78e3cf-53ea-4470-ac43-ce16438d8757"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7c78e3cf-53ea-4470-ac43-ce16438d8757",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa67"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7c78e3cf-53ea-4470-ac43-ce16438d8757{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7c78e3cf-53ea-4470-ac43-ce16438d8757/workflow"
        }
      }
    }, {
      "id" : "1eb24e51-279b-457b-ab62-8c30bacacd63",
      "folderId" : "5d722d2a46e0fb03670caa67",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.174Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.174Z",
      "deliveryId" : "1eb24e51-279b-457b-ab62-8c30bacacd63",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1eb24e51-279b-457b-ab62-8c30bacacd63"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1eb24e51-279b-457b-ab62-8c30bacacd63",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa67"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1eb24e51-279b-457b-ab62-8c30bacacd63{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1eb24e51-279b-457b-ab62-8c30bacacd63/workflow"
        }
      }
    }, {
      "id" : "7fe99c1e-b0f9-4b4a-9efd-8940d393f24d",
      "folderId" : "5d722d2a46e0fb03670caa66",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.152Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.152Z",
      "deliveryId" : "7fe99c1e-b0f9-4b4a-9efd-8940d393f24d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7fe99c1e-b0f9-4b4a-9efd-8940d393f24d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7fe99c1e-b0f9-4b4a-9efd-8940d393f24d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa66"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7fe99c1e-b0f9-4b4a-9efd-8940d393f24d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7fe99c1e-b0f9-4b4a-9efd-8940d393f24d/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62/content-items?folderId=5d722d2a46e0fb03670caa66&folderId=5d722d2a46e0fb03670caa67&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62/content-items?folderId=5d722d2a46e0fb03670caa66&folderId=5d722d2a46e0fb03670caa67&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62/content-items?folderId=5d722d2a46e0fb03670caa66&folderId=5d722d2a46e0fb03670caa67&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa62/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

Folder IDs can be made exclusive by prefixing with ! to request all content items not contained in the specified folder:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722d2a46e0fb03670caa6f/content-items?folderId=!5d722d2a46e0fb03670caa73 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 18428

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "72346ce3-6ad1-422d-bb47-adf8abd2cdeb",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Not in any folder",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.514Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.514Z",
      "deliveryId" : "72346ce3-6ad1-422d-bb47-adf8abd2cdeb",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=72346ce3-6ad1-422d-bb47-adf8abd2cdeb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=72346ce3-6ad1-422d-bb47-adf8abd2cdeb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=72346ce3-6ad1-422d-bb47-adf8abd2cdeb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72346ce3-6ad1-422d-bb47-adf8abd2cdeb/workflow"
        }
      }
    }, {
      "id" : "0230d953-bb35-4549-bbb5-ebd74a703e25",
      "folderId" : "5d722d2a46e0fb03670caa74",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.491Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.491Z",
      "deliveryId" : "0230d953-bb35-4549-bbb5-ebd74a703e25",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0230d953-bb35-4549-bbb5-ebd74a703e25"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0230d953-bb35-4549-bbb5-ebd74a703e25",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa74"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0230d953-bb35-4549-bbb5-ebd74a703e25{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0230d953-bb35-4549-bbb5-ebd74a703e25/workflow"
        }
      }
    }, {
      "id" : "96efdead-1474-480f-b03b-253a894ed74f",
      "folderId" : "5d722d2a46e0fb03670caa74",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.466Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.466Z",
      "deliveryId" : "96efdead-1474-480f-b03b-253a894ed74f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=96efdead-1474-480f-b03b-253a894ed74f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=96efdead-1474-480f-b03b-253a894ed74f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa74"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=96efdead-1474-480f-b03b-253a894ed74f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96efdead-1474-480f-b03b-253a894ed74f/workflow"
        }
      }
    }, {
      "id" : "a880124f-060c-4152-bc87-a1f0dfba66b5",
      "folderId" : "5d722d2a46e0fb03670caa74",
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:54.440Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:54.440Z",
      "deliveryId" : "a880124f-060c-4152-bc87-a1f0dfba66b5",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a880124f-060c-4152-bc87-a1f0dfba66b5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a880124f-060c-4152-bc87-a1f0dfba66b5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722d2a46e0fb03670caa74"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a880124f-060c-4152-bc87-a1f0dfba66b5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a880124f-060c-4152-bc87-a1f0dfba66b5/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f/content-items?folderId=!5d722d2a46e0fb03670caa73&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f/content-items?folderId=!5d722d2a46e0fb03670caa73&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f/content-items?folderId=!5d722d2a46e0fb03670caa73&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2a46e0fb03670caa6f/content-items/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

It is possible to specify multiple exclusive folder IDs, however it is best not to combine exclusive folder IDs with inclusive folder IDs when filtering. This is because the exclusive folder IDs will take precedence over the inclusive folder IDs. Consider filtering by:

?folderId=folder1,folder2,!folder3,!folder4

This query requests that only content items from folder1 and folder2 are included, and then requests all content items except those contained in folder3 and folder4. The content items from folder1 and folder2 are implicitly included as a result of excluding the content items from folder3 and folder4. Therefore the exclusive folder IDs have taken precedence, and an equivalent but more concise filter request would be:

?!folder3,!folder4

Listing Content Item History

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/history HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 19790

{
  "_embedded" : {
    "content-item-history" : [ {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.638Z",
        "historyEventId" : "e8eb1c2c-c79d-4f0c-9b29-d2df52053080"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a3e0ee65-0cc7-4c0a-9079-4fbeed1c20f4",
        "createdDate" : "2019-08-27T09:55:48.648Z",
        "historyEventId" : "f1706361-ac66-4768-ad16-871985dd8c8a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "28ea4728-60f9-41bb-ab50-10f0a34705a1",
        "createdDate" : "2019-08-26T09:55:48.648Z",
        "historyEventId" : "200f9607-75f2-437d-a4ca-8700d814b358"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4ea96706-db1a-4b05-9e49-5e3dcf020219",
        "createdDate" : "2019-08-25T09:55:48.648Z",
        "historyEventId" : "c16dc512-b5de-4412-a2fd-754a74b30c33"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5c8d3cfe-db65-432f-9053-864fdfe59014",
        "createdDate" : "2019-08-24T09:55:48.648Z",
        "historyEventId" : "29f1d484-c0c1-442b-836d-43fb931ee8c3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "81ea76fc-1055-476c-b4e2-57a3164138e6",
        "createdDate" : "2019-08-23T09:55:48.648Z",
        "historyEventId" : "4e27101e-44fa-45d5-91df-5628d23fe25a"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.636Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.589Z",
        "historyEventId" : "f0e5817a-7e2c-42f2-8843-2a2f1f6229d8"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2eea7314-2431-4eb0-b778-a652d22becf9",
        "createdDate" : "2019-08-26T09:55:48.648Z",
        "historyEventId" : "3b7a1a9f-923e-41e2-857a-b6367567dcb0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5309c53d-fa10-4c95-ab00-bb104a173ea1",
        "createdDate" : "2019-08-25T09:55:48.648Z",
        "historyEventId" : "ef5e3043-cc0c-44dd-b69c-2b4201537240"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "fa0eaff7-070c-4713-b47d-e35161084c58",
        "createdDate" : "2019-08-24T09:55:48.648Z",
        "historyEventId" : "521353cc-8022-4633-b319-3e4977fd2bbf"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "110a0e2c-98e3-4496-94ea-09c13ca66664",
        "createdDate" : "2019-08-23T09:55:48.648Z",
        "historyEventId" : "5d0598a9-6113-41bb-b647-1d896c424594"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c382eed6-1a4d-4292-b5e1-d711293c897a",
        "createdDate" : "2019-08-22T09:55:48.648Z",
        "historyEventId" : "33359d21-6312-4633-86c6-72c40f9627b9"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.587Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.540Z",
        "historyEventId" : "9607824b-819f-4335-8697-7960489140f1"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9eefbfc7-7311-4f58-b98e-07c11a95df36",
        "createdDate" : "2019-08-25T09:55:48.648Z",
        "historyEventId" : "cb6f1990-acb5-4344-a080-0c98a79625b3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6c139797-8df7-4eac-a04d-c611a2565816",
        "createdDate" : "2019-08-24T09:55:48.648Z",
        "historyEventId" : "d8808218-a712-4d21-ac30-f62203fcdaee"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4e509a99-6ecd-439e-8bb3-3b058a59de60",
        "createdDate" : "2019-08-23T09:55:48.648Z",
        "historyEventId" : "aeffea90-0a85-4688-a892-6916766dae92"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d4b4c211-f42d-4079-b9fb-5441a5529ae1",
        "createdDate" : "2019-08-22T09:55:48.648Z",
        "historyEventId" : "3656abd0-6b48-4c93-8347-4f238f89cb37"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "84d23443-a488-45bb-b05b-351146f5832b",
        "createdDate" : "2019-08-21T09:55:48.648Z",
        "historyEventId" : "29ed6edc-0f5e-4401-a6b1-1adeaad42ec3"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.538Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.489Z",
        "historyEventId" : "649d6978-1a7d-4f73-a4ef-75701b235565"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1b033cee-567d-4e1b-a82c-91fd0f18eb23",
        "createdDate" : "2019-08-24T09:55:48.648Z",
        "historyEventId" : "7756b83d-d369-4aee-bb5b-c253b4f696b9"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1e96cb1a-16bb-481a-8c83-d333390ee752",
        "createdDate" : "2019-08-23T09:55:48.648Z",
        "historyEventId" : "a32e1c68-3286-4143-9795-6e58f6a0c867"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b844ec7d-c922-403c-9d81-5e7e5e64acb7",
        "createdDate" : "2019-08-22T09:55:48.648Z",
        "historyEventId" : "9f9e1c66-8387-4461-9968-af21ea0a9fd2"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "801162a4-0d53-407e-804c-8fe32ad3a158",
        "createdDate" : "2019-08-21T09:55:48.648Z",
        "historyEventId" : "828effd8-7e77-4b72-9f31-6b42309f43e4"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "58c57c46-d706-4641-a58e-885f4542af3d",
        "createdDate" : "2019-08-20T09:55:48.648Z",
        "historyEventId" : "0229e88c-5035-4c0a-a4ae-8249edcc8b9f"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.487Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.452Z",
        "historyEventId" : "73308060-38f0-463f-ac45-624fbc8b05c4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "99da782f-2683-4d47-973f-ef4bce45ceaf",
        "createdDate" : "2019-08-23T09:55:48.648Z",
        "historyEventId" : "13a830f6-9d10-49a1-999c-a0dbce8c98ab"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c36b9483-8b65-4c0c-bf86-8f158e36fae6",
        "createdDate" : "2019-08-22T09:55:48.648Z",
        "historyEventId" : "65a48003-b01c-4073-912e-2c39a6da5418"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "86b65b07-4dfb-4acf-869a-5e5bbc701ed6",
        "createdDate" : "2019-08-21T09:55:48.648Z",
        "historyEventId" : "5b4eecf8-2d8f-4e6d-8fc8-7ddb6b0f5b8b"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "71a635d6-e010-49fa-a3ad-5dd2bebdd73b",
        "createdDate" : "2019-08-20T09:55:48.648Z",
        "historyEventId" : "59bc4652-925e-4f39-af28-3a3249d862f9"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "7be7ef2e-04a5-4b2e-abfe-426b057f1dba",
        "createdDate" : "2019-08-19T09:55:48.648Z",
        "historyEventId" : "49fc4008-a902-4ca9-b664-02ea01890b13"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.451Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.413Z",
        "historyEventId" : "28931a49-78c2-41d4-9df1-537c9078753d"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "37afcd74-1e77-45e8-a065-30427d16b478",
        "createdDate" : "2019-08-22T09:55:48.648Z",
        "historyEventId" : "059a947a-bd11-4696-8383-b124146bd59d"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "b8ab9775-11d9-4a4c-810a-625bb2b11a98",
        "createdDate" : "2019-08-21T09:55:48.648Z",
        "historyEventId" : "6ad6915d-1ed3-42bc-bcaf-3dc866c9037b"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "437526c0-dada-4438-b499-c05947c1b0b7",
        "createdDate" : "2019-08-20T09:55:48.648Z",
        "historyEventId" : "e7dc1489-e50d-42a3-a4e7-28ac224fcbed"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "e45d4b3b-bcf8-46df-87ce-6b62540c7963",
        "createdDate" : "2019-08-19T09:55:48.648Z",
        "historyEventId" : "53f2be4f-ddea-40bb-b2ba-e7d046f28dd8"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "97d7aad5-5ea1-415c-bd0a-f632cef0bf5e",
        "createdDate" : "2019-08-18T09:55:48.648Z",
        "historyEventId" : "8e576e1a-4b23-41d9-94b6-de7e3753a2fc"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.412Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.376Z",
        "historyEventId" : "231e447f-c786-4ef8-bf3d-4a51326432d9"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "473a6e7b-3cd7-425d-91db-3c1e3f6f7ea2",
        "createdDate" : "2019-08-21T09:55:48.648Z",
        "historyEventId" : "bcbbac9d-b99b-4bc3-8b7e-eaead3b9087e"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "adbd7d4e-a7c7-41cd-8f85-7ceca77ebf4f",
        "createdDate" : "2019-08-20T09:55:48.648Z",
        "historyEventId" : "8f70a38b-f921-4521-b66a-564284df9c26"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "f4ed0788-72ec-439a-9fbf-a834b4759f72",
        "createdDate" : "2019-08-19T09:55:48.648Z",
        "historyEventId" : "f9f07984-2bf5-4f71-9a51-d9ec1e8e2454"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2e6aa7e3-15f9-4822-8071-ace777a01cd5",
        "createdDate" : "2019-08-18T09:55:48.648Z",
        "historyEventId" : "ff4bd085-88e4-442d-8bd6-b6d98b12d62a"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.375Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.342Z",
        "historyEventId" : "4e61a547-49a3-47d3-95ed-6306dd5e292b"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "6b3ec507-fbfd-4696-929a-d51295591e5b",
        "createdDate" : "2019-08-20T09:55:48.648Z",
        "historyEventId" : "b01e3502-76db-41d6-abb7-c3af2aab4367"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "557a70f1-4d39-4e0f-8d92-d54358fa0000",
        "createdDate" : "2019-08-19T09:55:48.648Z",
        "historyEventId" : "b74090a3-73b8-45f9-99ad-c396aa6ce07d"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1b09375d-13b0-41e7-8699-d850d8f36d62",
        "createdDate" : "2019-08-18T09:55:48.648Z",
        "historyEventId" : "c92c7225-12f9-4dfb-aa36-8d1ce465d07b"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.341Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.299Z",
        "historyEventId" : "6ec06fd0-52e1-4a77-bdae-7c5cd4ac6df2"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "d3d56229-905d-41c0-b890-86f6f51d68df",
        "createdDate" : "2019-08-19T09:55:48.648Z",
        "historyEventId" : "e134a904-c1e3-4364-895c-5db32f41d680"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "86176086-21a5-4d27-b1d7-4403b247a499",
        "createdDate" : "2019-08-18T09:55:48.648Z",
        "historyEventId" : "f606e315-163a-47e2-9c71-e3715292a11d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.298Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:55:48.264Z",
        "historyEventId" : "bb42b783-a8eb-4dba-8e6d-1eec89d6249c"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6ad63f89-50b0-4ec4-981d-dc1d326ae58f",
        "createdDate" : "2019-08-18T09:55:48.648Z",
        "historyEventId" : "511e8642-3de6-413e-89ef-636fb5eb1fd4"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:48.263Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/63d1366c-9d95-459a-865a-2f807268dd0e/history?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 10,
    "totalPages" : 1,
    "number" : 0
  }
}

Listing Content Item History for a Version

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/214b1914-7005-4eab-827c-a241f950b0f4/versions/1/history HTTP/1.1
Accept: application/hal+json
Content-Type: application/json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6062

{
  "_embedded" : {
    "content-item-version-history" : [ {
      "historyEventId" : "2403bf57-cb54-4681-8f96-1e5f66bf30ce",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-09-06T09:56:22.215Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "bbe3d754-77dc-4d11-860f-c558e4e5b3d4",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-09-02T09:56:22.225Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "74fd9dd3-c7b1-4ca4-9ec6-1905db39bc63",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-09-01T09:56:22.225Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "88e9c96c-5cc5-4233-aaec-eadf5ffc3cfd",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-31T09:56:22.225Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0a4ded82-aa34-4db4-a055-c2c148319aec",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-30T09:56:22.225Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "cde19e85-b1e1-4ff8-a98c-f66099d1c306",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-29T09:56:22.225Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "c700c807-936c-487e-a6db-9cf44e45bcbb",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-28T09:56:22.225Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "3afd2359-e4fe-4c53-a139-f9948e495c3b",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-27T09:56:22.225Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0f0a42e9-62cc-426a-9a18-b6367bb0d361",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-26T09:56:22.225Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "52452ca5-551f-459c-9066-cbfc46caecd9",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-25T09:56:22.225Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "28b874c4-78aa-48c2-8d25-f0fb8fa0ecdb",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-24T09:56:22.225Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "1ce93ceb-80ec-459a-a331-f9bc04f84daf",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-23T09:56:22.225Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "eb8fa96d-7913-49e3-a96d-fec9f6b3d304",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-22T09:56:22.225Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "421ec87e-5d5c-45fd-bb92-0f9e55646cf7",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-21T09:56:22.225Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "026247d6-623a-4c14-b34a-acd098eaa73b",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-20T09:56:22.225Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "7e317b0a-f413-4604-9c2c-07434689fc6c",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-19T09:56:22.225Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "ff6fc740-bd5f-4d9d-af70-52e708382af4",
      "contentItemId" : "214b1914-7005-4eab-827c-a241f950b0f4",
      "version" : 1,
      "createdDate" : "2019-08-18T09:56:22.225Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/214b1914-7005-4eab-827c-a241f950b0f4/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/214b1914-7005-4eab-827c-a241f950b0f4/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/214b1914-7005-4eab-827c-a241f950b0f4/versions/1/history?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 17,
    "totalPages" : 1,
    "number" : 0
  }
}

Listing Content Item Versions

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5066

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "0ab1a794-171d-4dbd-9e96-5cdce4a94aef",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "I am version 2",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 2,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:37.857Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:37.898Z",
      "deliveryId" : "0ab1a794-171d-4dbd-9e96-5cdce4a94aef",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d0f46e0fb03670ca5f4"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0ab1a794-171d-4dbd-9e96-5cdce4a94aef"
        }
      }
    }, {
      "id" : "0ab1a794-171d-4dbd-9e96-5cdce4a94aef",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "main-banner",
          "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        },
        "heading" : "Buy more stuff!!",
        "link" : "http://anyafinn.com/buymore?campaign=shouting"
      },
      "version" : 1,
      "label" : "Banner Ad Homepage",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:37.857Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:37.898Z",
      "deliveryId" : "0ab1a794-171d-4dbd-9e96-5cdce4a94aef",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d0f46e0fb03670ca5f4"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0ab1a794-171d-4dbd-9e96-5cdce4a94aef"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0ab1a794-171d-4dbd-9e96-5cdce4a94aef/versions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Getting Linked Content Items

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/search/findByIdWithChildren?id=caaf9335-eeac-4377-a45d-d6fc05c81294 HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 13914

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "caaf9335-eeac-4377-a45d-d6fc05c81294",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "nested-2",
          "schema" : "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json"
        },
        "nested" : [ {
          "_meta" : {
            "schema" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType" : "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
          "id" : "c0b042df-843b-4a54-a8fe-38be392a6e66"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:16.268Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:16.268Z",
      "deliveryId" : "caaf9335-eeac-4377-a45d-d6fc05c81294",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/planned{?epoch,time}",
          "templated" : true
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=caaf9335-eeac-4377-a45d-d6fc05c81294"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cc746e0fb03670c8b23"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=caaf9335-eeac-4377-a45d-d6fc05c81294",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=caaf9335-eeac-4377-a45d-d6fc05c81294{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294/workflow"
        }
      }
    }, {
      "id" : "c0b042df-843b-4a54-a8fe-38be392a6e66",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "nested-1",
          "schema" : "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json"
        },
        "nested" : [ {
          "_meta" : {
            "schema" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
          },
          "contentType" : "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
          "id" : "594bb06d-1dc8-4ef0-8684-16652670701c"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:16.224Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:16.224Z",
      "deliveryId" : "c0b042df-843b-4a54-a8fe-38be392a6e66",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/planned{?epoch,time}",
          "templated" : true
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c0b042df-843b-4a54-a8fe-38be392a6e66"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cc746e0fb03670c8b23"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c0b042df-843b-4a54-a8fe-38be392a6e66",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c0b042df-843b-4a54-a8fe-38be392a6e66{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c0b042df-843b-4a54-a8fe-38be392a6e66/workflow"
        }
      }
    }, {
      "id" : "594bb06d-1dc8-4ef0-8684-16652670701c",
      "folderId" : null,
      "body" : {
        "_meta" : {
          "name" : "nested-0",
          "schema" : "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json"
        }
      },
      "version" : 1,
      "label" : "nested-0",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:16.078Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:16.078Z",
      "deliveryId" : "594bb06d-1dc8-4ef0-8684-16652670701c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=594bb06d-1dc8-4ef0-8684-16652670701c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cc746e0fb03670c8b23"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=594bb06d-1dc8-4ef0-8684-16652670701c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=594bb06d-1dc8-4ef0-8684-16652670701c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/594bb06d-1dc8-4ef0-8684-16652670701c/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=caaf9335-eeac-4377-a45d-d6fc05c81294"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/caaf9335-eeac-4377-a45d-d6fc05c81294{?projection}",
      "templated" : true
    }
  }
}

Finding Content by epoch

Find content items that are candidates for being published at a point in time.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/planned?epoch=4663230137000 HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2021

{
  "id" : "c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:21.678Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:21.678Z",
  "deliveryId" : "c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccd46e0fb03670c8e99"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c9ba2bbf-b553-4cf5-ac0b-1f137a3b88ff"
    }
  }
}

Finding Content by ISO 8601 time

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/planned?time=2100-10-31T01:30:00.000Z HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2047

{
  "id" : "2fdf4174-43dd-4644-94d9-ef4258e8761e",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "version" : 2,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:21.133Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:21.262Z",
  "deliveryId" : "2fdf4174-43dd-4644-94d9-ef4258e8761e",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2fdf4174-43dd-4644-94d9-ef4258e8761e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccc46e0fb03670c8e3f"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2fdf4174-43dd-4644-94d9-ef4258e8761e"
    }
  }
}

Finding Content by Content Version Number

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/versions/3 HTTP/1.1
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2057

{
  "id" : "9c44fbd1-88ed-4a44-aec7-99e4b518033c",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "bodyLabel" : "I am Version 3"
  },
  "version" : 3,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:17.431Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:17.615Z",
  "deliveryId" : "9c44fbd1-88ed-4a44-aec7-99e4b518033c",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c44fbd1-88ed-4a44-aec7-99e4b518033c/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cc946e0fb03670c8bd0"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9c44fbd1-88ed-4a44-aec7-99e4b518033c"
    }
  }
}

Restore Content by Content Version Number

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PUT /v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/restore HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 43

{
  "version" : 2,
  "restoreVersion" : 1
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:56:19 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "774e3205-ed73-42b9-b4b7-640b31c9eb74",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 3,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:56:19.869Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:56:19.950Z",
  "deliveryId" : "774e3205-ed73-42b9-b4b7-640b31c9eb74",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=774e3205-ed73-42b9-b4b7-640b31c9eb74"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3946e0fb03670cabb8"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=774e3205-ed73-42b9-b4b7-640b31c9eb74",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=774e3205-ed73-42b9-b4b7-640b31c9eb74{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/774e3205-ed73-42b9-b4b7-640b31c9eb74/workflow"
    }
  }
}

Search Content Items by Text

Text is the default search field. See Text Search Query Syntax for a summary of the query syntax.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d3846e0fb03670cab5f/content-items/find?query=uniondusk HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4559

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "5a33ddce-cbac-4917-af31-624057742aa3",
      "contentRepositoryId" : "5d722d3946e0fb03670cab60",
      "folderId" : null,
      "deliveryId" : "5a33ddce-cbac-4917-af31-624057742aa3",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:56:09.292Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:56:09.292Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3946e0fb03670cab60"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5a33ddce-cbac-4917-af31-624057742aa3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5a33ddce-cbac-4917-af31-624057742aa3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a33ddce-cbac-4917-af31-624057742aa3/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3846e0fb03670cab5f/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3846e0fb03670cab5f/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3846e0fb03670cab5f/content-items/find?query=uniondusk&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Faceting Content Items with Search by Text

Facet content items and search by text. See Text Search Query Syntax for a summary of the query syntax.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5d722d3046e0fb03670caacb/content-items/facet?sort=createdDate&createdDate.dir=desc HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 744

{
  "fields" : [ {
    "facetAs" : "ENUM",
    "filter" : {
      "type" : "EQ",
      "values" : [ "NONE" ]
    },
    "field" : "publishingStatus",
    "userFacingName" : "publishingStatus"
  }, {
    "facetAs" : "ENUM",
    "filter" : {
      "type" : "EQ",
      "values" : [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ]
    },
    "field" : "schema",
    "userFacingName" : "schema"
  }, {
    "facetAs" : "DATE",
    "filter" : {
      "type" : "DATE",
      "values" : [ "-29:DAYS,NOW" ]
    },
    "name" : "-30 days",
    "range" : {
      "start" : "-29:DAYS",
      "end" : "NOW",
      "gap" : "30:DAYS"
    },
    "field" : "lastModifiedDate",
    "userFacingName" : "-30 days"
  } ],
  "returnEntities" : true
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 80184

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "375d5bf0-b15a-42ed-8f62-62b23b6fe0c2",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "375d5bf0-b15a-42ed-8f62-62b23b6fe0c2",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1756191f-59fc-45f1-854b-9425177e2882",
      "createdBy" : "user",
      "createdDate" : "2019-08-08T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-08T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=375d5bf0-b15a-42ed-8f62-62b23b6fe0c2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=375d5bf0-b15a-42ed-8f62-62b23b6fe0c2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375d5bf0-b15a-42ed-8f62-62b23b6fe0c2/workflow"
        }
      }
    }, {
      "id" : "02fc485e-24bd-469a-b072-8454fe33aad8",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "02fc485e-24bd-469a-b072-8454fe33aad8",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1dfa38d6-d41d-49a2-80a4-61395cc9decc",
      "createdBy" : "user",
      "createdDate" : "2019-08-09T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-09T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=02fc485e-24bd-469a-b072-8454fe33aad8",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=02fc485e-24bd-469a-b072-8454fe33aad8{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/02fc485e-24bd-469a-b072-8454fe33aad8/workflow"
        }
      }
    }, {
      "id" : "bf73e4a3-a0f5-420e-bad6-e6da23432712",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "bf73e4a3-a0f5-420e-bad6-e6da23432712",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b3583f37-4e23-4bf4-ba93-8f0212f572cc",
      "createdBy" : "user",
      "createdDate" : "2019-08-10T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-10T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bf73e4a3-a0f5-420e-bad6-e6da23432712",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bf73e4a3-a0f5-420e-bad6-e6da23432712{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf73e4a3-a0f5-420e-bad6-e6da23432712/workflow"
        }
      }
    }, {
      "id" : "e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "a973f88f-2f0f-4204-aa4d-37eff845b544",
      "createdBy" : "user",
      "createdDate" : "2019-08-11T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-11T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e47ad2c0-ce97-4c14-bd5a-c8118f6d5fd3/workflow"
        }
      }
    }, {
      "id" : "aa1b7842-606c-40ec-b06c-7f8bdd224c86",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "aa1b7842-606c-40ec-b06c-7f8bdd224c86",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "e4b8c19d-4ef6-41ad-b827-277a29e5afb7",
      "createdBy" : "user",
      "createdDate" : "2019-08-12T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-12T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=aa1b7842-606c-40ec-b06c-7f8bdd224c86",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=aa1b7842-606c-40ec-b06c-7f8bdd224c86{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa1b7842-606c-40ec-b06c-7f8bdd224c86/workflow"
        }
      }
    }, {
      "id" : "b4027382-70dc-4ecb-90c1-730780d6985e",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "b4027382-70dc-4ecb-90c1-730780d6985e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "ddd290ac-d4c1-4b90-b658-fd728a1eb331",
      "createdBy" : "user",
      "createdDate" : "2019-08-13T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-13T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b4027382-70dc-4ecb-90c1-730780d6985e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b4027382-70dc-4ecb-90c1-730780d6985e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4027382-70dc-4ecb-90c1-730780d6985e/workflow"
        }
      }
    }, {
      "id" : "ad809355-d0f1-4efa-a513-39b6e03c435f",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "ad809355-d0f1-4efa-a513-39b6e03c435f",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3651828c-c5f8-42f2-87f9-9ce7bab11369",
      "createdBy" : "user",
      "createdDate" : "2019-08-14T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-14T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ad809355-d0f1-4efa-a513-39b6e03c435f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ad809355-d0f1-4efa-a513-39b6e03c435f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad809355-d0f1-4efa-a513-39b6e03c435f/workflow"
        }
      }
    }, {
      "id" : "1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "0eebbe85-ce50-4b06-9b96-71a03cfea126",
      "createdBy" : "user",
      "createdDate" : "2019-08-15T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-15T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1c1c31d3-66ed-45cf-9a5f-a55f6ba92f60/workflow"
        }
      }
    }, {
      "id" : "accfa16b-e588-45dc-ab4d-ecc933622de9",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "accfa16b-e588-45dc-ab4d-ecc933622de9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "8d1a91d2-8e94-40cc-90c1-9063ac602a3c",
      "createdBy" : "user",
      "createdDate" : "2019-08-16T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-16T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=accfa16b-e588-45dc-ab4d-ecc933622de9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=accfa16b-e588-45dc-ab4d-ecc933622de9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/accfa16b-e588-45dc-ab4d-ecc933622de9/workflow"
        }
      }
    }, {
      "id" : "58bfe381-9223-4340-8704-b04f6c078425",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "58bfe381-9223-4340-8704-b04f6c078425",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "2af03be7-0061-44d9-9ab9-7f9525407f81",
      "createdBy" : "user",
      "createdDate" : "2019-08-17T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-17T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=58bfe381-9223-4340-8704-b04f6c078425",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=58bfe381-9223-4340-8704-b04f6c078425{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58bfe381-9223-4340-8704-b04f6c078425/workflow"
        }
      }
    }, {
      "id" : "c365ea1b-e205-4059-9f85-e489de4fb19f",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "c365ea1b-e205-4059-9f85-e489de4fb19f",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "5da30279-18eb-4c31-b74d-16aa3932a018",
      "createdBy" : "user",
      "createdDate" : "2019-08-18T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-18T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c365ea1b-e205-4059-9f85-e489de4fb19f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c365ea1b-e205-4059-9f85-e489de4fb19f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c365ea1b-e205-4059-9f85-e489de4fb19f/workflow"
        }
      }
    }, {
      "id" : "663b3649-ef31-4fb9-b3dc-b212653749df",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "663b3649-ef31-4fb9-b3dc-b212653749df",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d9a6c733-5a4d-4b97-b3b9-653e3a5525cf",
      "createdBy" : "user",
      "createdDate" : "2019-08-19T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-19T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=663b3649-ef31-4fb9-b3dc-b212653749df",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=663b3649-ef31-4fb9-b3dc-b212653749df{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/663b3649-ef31-4fb9-b3dc-b212653749df/workflow"
        }
      }
    }, {
      "id" : "fad3af06-f6e2-489a-865a-6a1d82eddd6c",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "fad3af06-f6e2-489a-865a-6a1d82eddd6c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "c44d5f24-d48c-4ba7-80c3-dcd41f3ba8ec",
      "createdBy" : "user",
      "createdDate" : "2019-08-20T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-20T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fad3af06-f6e2-489a-865a-6a1d82eddd6c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fad3af06-f6e2-489a-865a-6a1d82eddd6c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fad3af06-f6e2-489a-865a-6a1d82eddd6c/workflow"
        }
      }
    }, {
      "id" : "416c66ac-2974-4ed9-9e32-cb286aba556d",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "416c66ac-2974-4ed9-9e32-cb286aba556d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "30fca58b-92bc-40b1-9e32-29af5f1a18f6",
      "createdBy" : "user",
      "createdDate" : "2019-08-21T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-21T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=416c66ac-2974-4ed9-9e32-cb286aba556d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=416c66ac-2974-4ed9-9e32-cb286aba556d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/416c66ac-2974-4ed9-9e32-cb286aba556d/workflow"
        }
      }
    }, {
      "id" : "4800a01f-c74f-44e0-a793-a0e459bc37cc",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "4800a01f-c74f-44e0-a793-a0e459bc37cc",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3df709a8-d82b-4202-bd00-f19c3bb3c831",
      "createdBy" : "user",
      "createdDate" : "2019-08-22T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-22T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4800a01f-c74f-44e0-a793-a0e459bc37cc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4800a01f-c74f-44e0-a793-a0e459bc37cc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4800a01f-c74f-44e0-a793-a0e459bc37cc/workflow"
        }
      }
    }, {
      "id" : "277dceb4-b94f-4451-b424-b3ca7966272b",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "277dceb4-b94f-4451-b424-b3ca7966272b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "6f8bd779-af3c-4bfa-a3a7-3dcfc6fb1803",
      "createdBy" : "user",
      "createdDate" : "2019-08-23T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-23T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=277dceb4-b94f-4451-b424-b3ca7966272b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=277dceb4-b94f-4451-b424-b3ca7966272b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/277dceb4-b94f-4451-b424-b3ca7966272b/workflow"
        }
      }
    }, {
      "id" : "a37ce696-e683-4bcf-8909-bd7d66ac4b0f",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "a37ce696-e683-4bcf-8909-bd7d66ac4b0f",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "51f6f249-6b96-41a7-b7c6-aac5191e1c92",
      "createdBy" : "user",
      "createdDate" : "2019-08-24T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-24T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a37ce696-e683-4bcf-8909-bd7d66ac4b0f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a37ce696-e683-4bcf-8909-bd7d66ac4b0f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a37ce696-e683-4bcf-8909-bd7d66ac4b0f/workflow"
        }
      }
    }, {
      "id" : "1f6722eb-0987-4e7c-a4c4-1121158141ab",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "1f6722eb-0987-4e7c-a4c4-1121158141ab",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "ad9b0605-e4cb-4ec2-a346-f8cc595017a0",
      "createdBy" : "user",
      "createdDate" : "2019-08-25T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-25T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1f6722eb-0987-4e7c-a4c4-1121158141ab",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1f6722eb-0987-4e7c-a4c4-1121158141ab{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f6722eb-0987-4e7c-a4c4-1121158141ab/workflow"
        }
      }
    }, {
      "id" : "5003e023-0cfd-406d-aaf4-6dd8fe317b89",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "5003e023-0cfd-406d-aaf4-6dd8fe317b89",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "2a95daaa-0f6e-4bcd-aa0e-30ee98c71663",
      "createdBy" : "user",
      "createdDate" : "2019-08-26T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-26T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5003e023-0cfd-406d-aaf4-6dd8fe317b89",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5003e023-0cfd-406d-aaf4-6dd8fe317b89{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5003e023-0cfd-406d-aaf4-6dd8fe317b89/workflow"
        }
      }
    }, {
      "id" : "a1e5b264-194e-48fa-b4ff-78104d938a3e",
      "contentRepositoryId" : "5d722d3046e0fb03670caad1",
      "folderId" : null,
      "deliveryId" : "a1e5b264-194e-48fa-b4ff-78104d938a3e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "60cd6ae2-620a-4d70-b1bf-c87c659a6c05",
      "createdBy" : "user",
      "createdDate" : "2019-08-27T09:55:59.917Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-08-27T09:55:59.917Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d3046e0fb03670caad1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a1e5b264-194e-48fa-b4ff-78104d938a3e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a1e5b264-194e-48fa-b4ff-78104d938a3e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a1e5b264-194e-48fa-b4ff-78104d938a3e/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3046e0fb03670caacb/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3046e0fb03670caacb/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3046e0fb03670caacb/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d3046e0fb03670caacb/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 30,
    "totalPages" : 2,
    "number" : 0
  },
  "_facets" : {
    "schema" : [ {
      "_id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "count" : 30
    } ],
    "-30 days" : [ {
      "_id" : "-29:DAYS,NOW",
      "count" : 30
    } ],
    "publishingStatus" : [ {
      "_id" : "NONE",
      "count" : 30
    } ]
  }
}

Text Search Query Syntax

A simple query syntax is provided to allow full text search on content items. Several characters have special meaning and are reserved:

Table 2. Reserved Search Characters
Description Symbol

Negation Operator

-

Field Search Operator

:

Quote (for exact search)

"

Comma (list multiple search terms)

,

Please note that the text search is case insensitive, and will only display content items within the hub. See the following examples for an explanation of the query syntax:

Table 3. Text Search Examples
Query Meaning

apple

Find all content items containing the word "apple"

apple orange

Find all content items containing the words "apple" AND "orange"

apple,orange

Find all content items containing either "apple" OR "orange"

apple -orange

Find all content items that contain the word "apple" but NOT "orange"

-apple-orange

Find all content items that don’t contain "apple-orange" (hyphens in the middle of a word are not treated as negation)

label:apple

Find all content items that contain the word "apple" within the "label" field

"apple:orange"

Find all content items containing "apple:orange" (quotes must be used to search for a colon character)

apple label:orange

Find all content items containing the word "apple" anywhere within them, AND the word "orange" in the label field

Publish Content Item

In order to publish a content item follow the HAL link with the rel "publish" on a Content item, which will return with the location of the newly created Publishing-Job.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/content-items/db9e8453-453f-4bc0-92ef-b4f5977dc6db/publish HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 3

{ }

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/publishing-jobs/5d722d2546e0fb03670ca70a

Get Edition Slot Associations

This allows a user to see all places a content item is used.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/e1141243-11b2-42c7-9dc2-e2c0d7f5ad52/edition-slot-associations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1487

{
  "contentItemId" : "e1141243-11b2-42c7-9dc2-e2c0d7f5ad52",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5d722d2646e0fb03670ca81d",
    "eventStart" : "2019-09-06T09:54:28.096Z",
    "eventEnd" : "2019-10-06T09:54:28.096Z",
    "editionTitle" : "Test",
    "editionId" : "5d722d2646e0fb03670ca81e",
    "editionStart" : "2019-09-06T09:54:28.096Z",
    "editionEnd" : "2019-10-06T09:54:28.096Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5d722d2646e0fb03670ca823",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2019-09-06T09:55:51.127Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-09-06T09:55:51.095Z",
    "snapshotId" : "5d722d2746e0fb03670ca829",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5d722d2646e0fb03670ca81e/slots/5d722d2646e0fb03670ca823"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5d722d2646e0fb03670ca81e/slots/5d722d2646e0fb03670ca823/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e1141243-11b2-42c7-9dc2-e2c0d7f5ad52/edition-slot-associations"
    }
  }
}

Localization

See Localization for info on how to work with Content Item level localization. Including APIs for assigning a locale to your content and preparing for translating content into other languages.

Assigning a workflow

You can assign a workflow to a Content Item as long as they share a hub.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

{
  "version" : 1,
  "state" : "5d722d0f46e0fb03670ca4fa"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3969

{
  "id" : "050c742c-6da6-4c44-acf0-dd64b4808cbc",
  "workflow" : {
    "state" : "5d722d0f46e0fb03670ca4fa"
  },
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:27.216Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:27.254Z",
  "deliveryId" : "050c742c-6da6-4c44-acf0-dd64b4808cbc",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=050c742c-6da6-4c44-acf0-dd64b4808cbc"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d0f46e0fb03670ca4f8"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=050c742c-6da6-4c44-acf0-dd64b4808cbc",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=050c742c-6da6-4c44-acf0-dd64b4808cbc{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/050c742c-6da6-4c44-acf0-dd64b4808cbc/workflow"
    }
  }
}

for more information on workflows see Workflows

Events

An Event represents a major date in the calendar, such as Christmas or Black Friday. An Event may span multiple days and start and end at any given UTC time.

An Event contains a collection of Editions.

Creating a new Event

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:CREATE

Required ACLs:
  • Hub - READ

  • Hub - CREATE_EVENT

Example request

POST /v2/content/hubs/5d722d5646e0fb03670cc287/events HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 204

{
  "name" : "January Sale",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "brief" : "http://external.doc/mybrief",
  "comment" : "This is an event.",
  "locales" : [ ]
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1256

{
  "id" : "5d722d5646e0fb03670cc288",
  "name" : "January Sale",
  "comment" : "This is an event.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "brief" : "http://external.doc/mybrief",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Get an Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5d722d5646e0fb03670cc288 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1256

{
  "id" : "5d722d5646e0fb03670cc288",
  "name" : "January Sale",
  "comment" : "This is an event.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "brief" : "http://external.doc/mybrief",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Get an Event with Editions

It is possible to retrieve both the Event and its child Editions in a single request. Simply add the projection=withEditions query string parameter to the request as shown below.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5d722d5646e0fb03670cc288 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1256

{
  "id" : "5d722d5646e0fb03670cc288",
  "name" : "January Sale",
  "comment" : "This is an event.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "brief" : "http://external.doc/mybrief",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d5646e0fb03670cc287/events HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2070

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5646e0fb03670cc288",
      "name" : "January Sale",
      "comment" : "This is an event.",
      "start" : "2017-01-01T00:00:00.000Z",
      "end" : "2017-01-01T23:59:59.000Z",
      "brief" : "http://external.doc/mybrief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287/events?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287/events?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287/events?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc287/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

It is also possible to include the Editions of each Event in the response by using the projection=withEditions query string parameter as shown above.

Updating an Event

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EVENT

Example request

PATCH /v2/content/events/5d722d4f46e0fb03670cbac2 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 133

{
  "name" : "shoes",
  "start" : "2019-09-06T10:56:31.853Z",
  "end" : "2019-09-06T13:56:31.853Z",
  "brief" : "http://test/path2"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1239

{
  "id" : "5d722d4f46e0fb03670cbac2",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-09-06T10:56:31.853Z",
  "end" : "2019-09-06T13:56:31.853Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4f46e0fb03670cbac1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d4f46e0fb03670cbac2/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Delete an Event

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:DELETE

Required ACLs:
  • Hub - READ

  • Hub - DELETE_EVENT

Example request

DELETE /v2/content/events/5d722d4f46e0fb03670cba6f HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Searching Events

findByDate

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5046e0fb03670cbb14&rangeEnd=2019-09-09T09:56:32.000Z&rangeStart=2019-09-03T09:56:32.000Z&bounded=0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 7945

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5046e0fb03670cbb1c",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-08-31T09:56:32.000Z",
      "end" : "2019-09-03T09:56:32.000Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb14"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1c/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5046e0fb03670cbb1a",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-08-31T09:56:32.000Z",
      "end" : "2019-09-04T09:56:32.000Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb14"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1a/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5046e0fb03670cbb18",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-09-06T09:56:32.000Z",
      "end" : "2019-09-08T09:56:32.000Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb14"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb18/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5046e0fb03670cbb19",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-09-08T09:56:32.000Z",
      "end" : "2019-09-12T09:56:32.000Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb14"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb19/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5046e0fb03670cbb1b",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-09-09T09:56:32.000Z",
      "end" : "2019-09-12T09:56:32.000Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb14"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb1b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5046e0fb03670cbb14&rangeStart=2019-09-03T09:56:32.000Z&rangeEnd=2019-09-09T09:56:32.000Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5046e0fb03670cbb14&rangeStart=2019-09-03T09:56:32.000Z&rangeEnd=2019-09-09T09:56:32.000Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5046e0fb03670cbb14&rangeStart=2019-09-03T09:56:32.000Z&rangeEnd=2019-09-09T09:56:32.000Z&bounded=false&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}
With Edition Projection

To expose the Editions that are associated with the Event you can use the projection=withEditions query string parameter as shown below.

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5546e0fb03670cc21a&rangeEnd=2019-09-09T09:56:37.828Z&rangeStart=2019-09-03T09:56:37.828Z&bounded=0&projection=withEditions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3150

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5546e0fb03670cc21b",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-09-07T09:56:37.828Z",
      "end" : "2019-09-08T09:56:37.828Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5d722d5546e0fb03670cc21c",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-09-07T09:56:37.828Z",
        "end" : "2019-09-08T09:56:37.828Z",
        "eventId" : "5d722d5546e0fb03670cc21b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:37.937Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:37.938Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:37.938Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5546e0fb03670cc21a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc21b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5546e0fb03670cc21a&rangeStart=2019-09-03T09:56:37.828Z&rangeEnd=2019-09-09T09:56:37.828Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5546e0fb03670cc21a&rangeStart=2019-09-03T09:56:37.828Z&rangeEnd=2019-09-09T09:56:37.828Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5546e0fb03670cc21a&rangeStart=2019-09-03T09:56:37.828Z&rangeEnd=2019-09-09T09:56:37.828Z&bounded=false&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Optional End Date

The rangeEnd is optional

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc223&rangeStart=2019-09-06T09:56:38.069Z&bounded=0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5053

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5646e0fb03670cc228",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-09-04T09:56:38.069Z",
      "end" : "2019-09-08T09:56:38.069Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc223"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc228/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5646e0fb03670cc227",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-09-06T09:56:38.069Z",
      "end" : "2019-09-08T09:56:38.069Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc223"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc227/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d5646e0fb03670cc226",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-09-07T09:56:38.069Z",
      "end" : "2019-09-08T09:56:38.069Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc223"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc226/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc223&rangeStart=2019-09-06T09:56:38.069Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc223&rangeStart=2019-09-06T09:56:38.069Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc223&rangeStart=2019-09-06T09:56:38.069Z&bounded=false&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}
Find Expired Events

Set the "bounded" flag to "1" to look for events have started and ended for the given range. Set the page size to the lowest value "1"

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeEnd=2019-09-05T23:59:59.999Z&rangeStart=2017-01-01T00:00:00.000Z&bounded=1&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2349

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5646e0fb03670cc230",
      "name" : "Yesterday",
      "comment" : "This is an event.",
      "start" : "2019-09-05T00:00:00.000Z",
      "end" : "2019-09-05T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc22c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc230/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-09-05T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-09-05T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-09-05T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
Find Live Events

Set the "bounded" flag to "0", to look for events that are active during the given range. Set the page size to the lowest value "1"

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeEnd=2019-09-06T23:59:59.999Z&rangeStart=2019-09-06T00:00:00.000Z&bounded=0&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2596

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5646e0fb03670cc234",
      "name" : "Yesterday to Today",
      "comment" : "This is an event.",
      "start" : "2019-09-05T00:00:00.000Z",
      "end" : "2019-09-06T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc22c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc234/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-06T00:00:00.000Z&rangeEnd=2019-09-06T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-06T00:00:00.000Z&rangeEnd=2019-09-06T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-06T00:00:00.000Z&rangeEnd=2019-09-06T23:59:59.999Z&bounded=false&page=1&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-06T00:00:00.000Z&rangeEnd=2019-09-06T23:59:59.999Z&bounded=false&page=3&size=1"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 1,
    "totalElements" : 4,
    "totalPages" : 4,
    "number" : 0
  }
}
Find Upcoming Events

Set the "bounded" flag to "1" to look for events have started and end for the given range. Set the page size to the lowest value "1"

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeEnd=2019-09-07T23:59:59.999Z&rangeStart=2019-09-07T00:00:00.000Z&bounded=1&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2348

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5646e0fb03670cc232",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-09-07T00:00:00.000Z",
      "end" : "2019-09-07T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5646e0fb03670cc22c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc232/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-07T00:00:00.000Z&rangeEnd=2019-09-07T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-07T00:00:00.000Z&rangeEnd=2019-09-07T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d722d5646e0fb03670cc22c&rangeStart=2019-09-07T00:00:00.000Z&rangeEnd=2019-09-07T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Find Events By Date Range and Slots

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5546e0fb03670cc207&rangeEnd=2019-09-09T09:56:37.606Z&rangeStart=2019-09-03T09:56:37.606Z&bounded=0&slots=b3d4c2f0-5829-4382-b5ed-8cd2410e5976&locales=en-GB HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2563

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5546e0fb03670cc20b",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-09-06T09:56:37.606Z",
      "end" : "2019-09-08T09:56:37.606Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5546e0fb03670cc207"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5546e0fb03670cc20b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5546e0fb03670cc207&rangeStart=2019-09-03T09:56:37.606Z&rangeEnd=2019-09-09T09:56:37.606Z&bounded=false&slots=b3d4c2f0-5829-4382-b5ed-8cd2410e5976&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5546e0fb03670cc207&rangeStart=2019-09-03T09:56:37.606Z&rangeEnd=2019-09-09T09:56:37.606Z&bounded=false&slots=b3d4c2f0-5829-4382-b5ed-8cd2410e5976&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5546e0fb03670cc207&rangeStart=2019-09-03T09:56:37.606Z&rangeEnd=2019-09-09T09:56:37.606Z&bounded=false&slots=b3d4c2f0-5829-4382-b5ed-8cd2410e5976&locales=en-GB&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
With Edition Projection

To expose the Editions that are associated with the Event you can use the projection=withEditions query string parameter as shown below.

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5046e0fb03670cbb20&rangeEnd=2019-09-09T09:56:32.403Z&rangeStart=2019-09-03T09:56:32.403Z&bounded=0&projection=withEditions&slots=297d814b-a938-4744-8f88-6487e6095877&size=50 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 40630

{
  "_embedded" : {
    "events" : [ {
      "id" : "5d722d5046e0fb03670cbb26",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-09-06T09:56:32.403Z",
      "end" : "2019-09-08T09:56:32.403Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5d722d5046e0fb03670cbb27",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.563Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.564Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.582Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb29",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.592Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.593Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.618Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb2c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.629Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.629Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.650Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb30",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.660Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.661Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.684Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb35",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.694Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.695Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.719Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb3b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.729Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.730Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.754Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb42",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.766Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.767Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.790Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb4a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.800Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.800Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.825Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb53",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.835Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.836Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.866Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb5d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.877Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.877Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.909Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb68",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.923Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.924Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.955Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5046e0fb03670cbb74",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:32.966Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:32.966Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:32.994Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbb81",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.006Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.006Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.037Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbb8f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.049Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.049Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.082Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbb9e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.095Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.096Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.132Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbbae",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.145Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.145Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.185Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbbbf",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.196Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.197Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.232Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbbd1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.244Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.244Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.282Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbbe4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.293Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.293Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.326Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbbf8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.337Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.338Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.374Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc0d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.384Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.385Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.423Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc23",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.433Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.434Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.469Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc3a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.479Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.479Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.524Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc52",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.538Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.538Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.577Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc6b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.590Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.591Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.629Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbc85",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.640Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.640Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.688Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbca0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.699Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.699Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.747Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbcbc",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.758Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.758Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.805Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbcd9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.817Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.817Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.863Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbcf7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.876Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.876Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.923Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbd16",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.934Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.935Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:33.978Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5146e0fb03670cbd36",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:33.989Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:33.990Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.035Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbd57",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.046Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.047Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.094Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbd79",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.105Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.106Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.155Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbd9c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.166Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.166Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.216Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbdc0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.226Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.227Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.278Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbde5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.289Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.290Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.335Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbe0b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.346Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.346Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.393Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbe32",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.404Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.405Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.459Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbe5a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.470Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.470Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.525Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbe83",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.539Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.540Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.629Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbead",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.640Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.640Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.693Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbed8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.704Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.705Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.759Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbf04",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.770Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.770Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.824Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbf31",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.835Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.835Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.894Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbf5f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.906Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.906Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:34.966Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5246e0fb03670cbf8e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:34.978Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:34.978Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:35.054Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5346e0fb03670cbfbe",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:35.069Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:35.069Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:35.147Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5346e0fb03670cbfef",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:35.159Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:35.159Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:35.216Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d722d5346e0fb03670cc021",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-09-06T09:56:32.403Z",
        "end" : "2019-09-08T09:56:32.403Z",
        "eventId" : "5d722d5046e0fb03670cbb26",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-09-06T09:56:35.228Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-09-06T09:56:35.229Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-09-06T09:56:35.294Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d5046e0fb03670cbb20"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5046e0fb03670cbb26/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5046e0fb03670cbb20&rangeStart=2019-09-03T09:56:32.403Z&rangeEnd=2019-09-09T09:56:32.403Z&bounded=false&slots=297d814b-a938-4744-8f88-6487e6095877&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5046e0fb03670cbb20&rangeStart=2019-09-03T09:56:32.403Z&rangeEnd=2019-09-09T09:56:32.403Z&bounded=false&slots=297d814b-a938-4744-8f88-6487e6095877&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d722d5046e0fb03670cbb20&rangeStart=2019-09-03T09:56:32.403Z&rangeEnd=2019-09-09T09:56:32.403Z&bounded=false&slots=297d814b-a938-4744-8f88-6487e6095877&page=0&size=50"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Editions

An Edition is the main way of scheduling content to be published on a specific date. It holds the association between slots and content items. Once all slots are valid and there are no conflicts, it is ready to be scheduled.

Creating a new Edition

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

  • CONTENT:FUNCTIONAL:EDITION:CREATE

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EVENT

  • Hub - CREATE_EDITION

Example request

POST /v2/content/events/5d722d5646e0fb03670cc288/editions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 179

{
  "name" : "January Sale",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:56:38 GMT
Location: https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

{
  "id" : "5d722d5646e0fb03670cc289",
  "name" : "January Sale",
  "comment" : "This is an example edition.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "eventId" : "5d722d5646e0fb03670cc288",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-09-06T09:56:38.581Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:56:38.581Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:56:38.581Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slot-collisions"
    }
  }
}

Duplicate an Edition

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

  • CONTENT:FUNCTIONAL:EDITION:CREATE

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EVENT

  • Hub - CREATE_EDITION

Example request

POST /v2/content/events/5d722d0e46e0fb03670ca3e6/editions?sourceEditionId=5d722d0e46e0fb03670ca3ef HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 171

{
  "name" : "Test",
  "start" : "2019-09-06T09:54:28.096Z",
  "end" : "2019-10-06T09:54:28.096Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:26 GMT
Location: https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2619

{
  "id" : "5d722d0e46e0fb03670ca3f6",
  "name" : "Test",
  "comment" : "This is an example edition.",
  "start" : "2019-09-06T09:54:28.096Z",
  "end" : "2019-10-06T09:54:28.096Z",
  "eventId" : "5d722d0e46e0fb03670ca3e6",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 197,
  "versionConflicts" : {
    "limitExceeded" : false,
    "conflicts" : 0
  },
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-09-06T09:55:26.571Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:26.572Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:26.572Z",
  "stagedDate" : null,
  "slotCollisions" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d0e46e0fb03670ca3e6"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0e46e0fb03670ca3f6/slot-collisions"
    }
  }
}

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5d722d5646e0fb03670cc288/editions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3509

{
  "_embedded" : {
    "editions" : [ {
      "id" : "5d722d5646e0fb03670cc289",
      "name" : "January Sale",
      "comment" : "This is an example edition.",
      "start" : "2017-01-01T00:00:00.000Z",
      "end" : "2017-01-01T23:59:59.000Z",
      "eventId" : "5d722d5646e0fb03670cc288",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-09-06T09:56:38.581Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:56:38.581Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:56:38.581Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288/editions/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Get an Edition

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722d5646e0fb03670cc289 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:56:38 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

{
  "id" : "5d722d5646e0fb03670cc289",
  "name" : "January Sale",
  "comment" : "This is an example edition.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "eventId" : "5d722d5646e0fb03670cc288",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-09-06T09:56:38.581Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:56:38.581Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:56:38.581Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d5646e0fb03670cc288"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d5646e0fb03670cc289/slot-collisions"
    }
  }
}

Updating an Edition

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EVENT

  • Hub - EDIT_EDITION

Example request

PATCH /v2/content/editions/5d722d0d46e0fb03670ca2e8 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 175

{
  "name" : "New Name",
  "start" : "2019-09-06T09:54:28.096Z",
  "end" : "2019-09-12T09:54:28.096Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:25 GMT
Location: https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2545

{
  "id" : "5d722d0d46e0fb03670ca2e8",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-09-06T09:54:28.096Z",
  "end" : "2019-09-12T09:54:28.096Z",
  "eventId" : "5d722d0d46e0fb03670ca2e7",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-09-06T09:55:25.623Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:25.624Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:25.647Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d0d46e0fb03670ca2e7"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca2e8/slot-collisions"
    }
  }
}

Delete an Edition

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

  • CONTENT:FUNCTIONAL:EDITION:DELETE

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EVENT

  • Hub - DELETE_EDITION

Example request

DELETE /v2/content/editions/5d722cfd46e0fb03670ca155 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Schedule an Edition

In order to schedule an Edition, the Edition must be in the DRAFT state, all Edition Slots must be in the 'VALID' state, and there must be no conflicts in the Edition. This will then trigger the publishing job to take place on the start date of the Edition.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:SCHEDULE

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

POST /v2/content/editions/5d722d0c46e0fb03670ca21c/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-09-06T09:55:24.568Z"
}

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Unschedule an Edition

If the Edition has been scheduled it is possible to cancel the publishing job by unscheduling the edition.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:SCHEDULE

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

DELETE /v2/content/editions/5d722d0d46e0fb03670ca289/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Create an Edition Preview

In order to create an Edition preview, the Edition must be in the DRAFT state, at least one Edition Slots must be in the 'VALID' state, and there must be no conflicts in the Edition. This creates a publishing snapshot that can be previewed through the app or in Time Machine.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

POST /v2/content/editions/5d722cfb46e0fb03670ca022/preview HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 80

{
  "lastModifiedDate" : "2019-09-06T09:55:07.906Z",
  "type" : "QUICKPREVIEW"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 290

{
  "snapshotId" : "5d722cfb46e0fb03670ca02d",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722cfb46e0fb03670ca02d"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722cfb46e0fb03670ca02d"
    }
  }
}

Get an Edition Preview

If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722cfc46e0fb03670ca08c/preview HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 290

{
  "snapshotId" : "5d722cfc46e0fb03670ca097",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722cfc46e0fb03670ca097"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722cfc46e0fb03670ca097"
    }
  }
}

Delete an Edition Preview

If an Edition has been Previewed it can be deleted, if the Edition is Scheduled then it cannot be deleted.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

DELETE /v2/content/editions/5d722cfd46e0fb03670ca0f6/preview HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Search Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5d722d0d46e0fb03670ca33b/editions/search HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 610

{
  "_links" : {
    "findByEvent" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d722d0d46e0fb03670ca33b{&page,size,sort}",
      "templated" : true
    },
    "findOneByPublishManifestId" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findOneByPublishManifestId"
    },
    "findOneByPublishingJobId" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findOneByPublishingJobId"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d722d0d46e0fb03670ca33b/editions/search"
    }
  }
}

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/search/findByEvent?eventId=5d722d0d46e0fb03670ca33b HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 9196

{
  "_embedded" : {
    "editions" : [ {
      "id" : "5d722d0d46e0fb03670ca33d",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-09-06T09:54:28.096Z",
      "end" : "2019-09-06T11:54:28.096Z",
      "eventId" : "5d722d0d46e0fb03670ca33b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-09-06T09:55:25.774Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:25.775Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:25.775Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d0d46e0fb03670ca33b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33d/slot-collisions"
        }
      }
    }, {
      "id" : "5d722d0d46e0fb03670ca33c",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-09-06T10:54:28.096Z",
      "end" : "2019-09-06T11:54:28.096Z",
      "eventId" : "5d722d0d46e0fb03670ca33b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-09-06T09:55:25.762Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:25.762Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:25.762Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d0d46e0fb03670ca33b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33c/slot-collisions"
        }
      }
    }, {
      "id" : "5d722d0d46e0fb03670ca33e",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-09-06T10:54:29.096Z",
      "end" : "2019-09-06T11:54:28.096Z",
      "eventId" : "5d722d0d46e0fb03670ca33b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-09-06T09:55:25.786Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:55:25.787Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:55:25.787Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d722d0d46e0fb03670ca33b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d0d46e0fb03670ca33e/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d722d0d46e0fb03670ca33b&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d722d0d46e0fb03670ca33b&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d722d0d46e0fb03670ca33b&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Edition Conflicts

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722cea46e0fb03670c9e85/conflicts HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 678

{
  "conflictingItems" : [ {
    "contentItemId" : "f8380007-8f29-4080-9d97-12306361c646",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cea46e0fb03670c9e85/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cea46e0fb03670c9e85"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cea46e0fb03670c9e85/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    }
  }
}

Get Edition Conflict By ID and Version

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722ceb46e0fb03670c9eea/conflicts/findByIdAndVersion?id=04338f1a-e050-4a06-b2a5-d76593a49255&version=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1038

{
  "editionId" : "5d722ceb46e0fb03670c9eea",
  "contentItemId" : "04338f1a-e050-4a06-b2a5-d76593a49255",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5d722ceb46e0fb03670c9eeb",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:51.418Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5d722ceb46e0fb03670c9eed",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "04338f1a-e050-4a06-b2a5-d76593a49255",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ceb46e0fb03670c9eea/conflicts/findByIdAndVersion?id=04338f1a-e050-4a06-b2a5-d76593a49255&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ceb46e0fb03670c9eea"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ceb46e0fb03670c9eea/conflicts"
    }
  }
}

Resolve Edition Conflicts

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EVENT:EDIT

  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

PUT /v2/content/editions/5d722ceb46e0fb03670c9f4a/conflicts HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 194

{
  "comment" : "Do that thing!",
  "lastModifiedDate" : "2019-09-06T09:54:52.191Z",
  "resolutions" : [ {
    "contentItemId" : "618338c5-abe9-4445-8698-6eaad3121f43",
    "version" : 1
  } ]
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Get Edition Slot Collisions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722cea46e0fb03670c9e21/slot-collisions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 742

{
  "editionId" : "5d722cea46e0fb03670c9e21",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-09-06T09:54:28.096Z",
    "endDateTime" : "2019-10-06T09:54:28.096Z",
    "editionId" : "5d722cea46e0fb03670c9e1c",
    "collidingSlotIds" : [ "8ce95738-2752-4417-9289-064241d38527", "d9dc7858-7200-4fe6-8c7c-ba4b294c9a16" ],
    "eventName" : "Test",
    "eventId" : "5d722cea46e0fb03670c9e1b"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cea46e0fb03670c9e21/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cea46e0fb03670c9e21/slot-collisions"
    }
  }
}

Copy Edition Slot To Edition

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

POST /v2/content/editions/5d722cd446e0fb03670c98c7/slots?sourceEditionSlotId=5d722cd446e0fb03670c98c5 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5d722cd446e0fb03670c98c5

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:28 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1652

{
  "id" : "5d722cd446e0fb03670c98c8",
  "eventId" : "5d722cd446e0fb03670c98c6",
  "editionId" : "5d722cd446e0fb03670c98c7",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:28.405Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:28.405Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d722cd446e0fb03670c98bd",
  "slotId" : "22f4d345-ab9c-455a-8c05-eb40b99d8017",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c98c7/slots/5d722cd446e0fb03670c98c8"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c98c7/slots/5d722cd446e0fb03670c98c8"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c98c7"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22f4d345-ab9c-455a-8c05-eb40b99d8017{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c98c7/slots/5d722cd446e0fb03670c98c8/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c98c7/slots/5d722cd446e0fb03670c98c8/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Slots

"Slots" are content-items which are stored in separate repositories from other content-item items. Their role is to be placeholders for snapshots.

Example Slot Content Type

{
  "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
  "id" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
  "title" : "slot",
  "description" : "Slot Container",
  "type":"object",
  "properties": {
    "slot": {
      "title": "simple slot container",
      "allOf":[
        {"$ref": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link" },
        {
          "properties": {
            "contentType": { "enum": [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ] }
          }
        }
      ]
    }
  }
}

You will need to register a content type capable of holding nested content in order to create a slot.

Creating a Slot Repository

A Slot Repository is just a Content Repository with the "slots" feature. (See adding features to repositories)

Creating a Slot

A Slot is just a Content Item in a Slot Repository. Here’s a sample Content Item for the above Slot Type

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5d722ce446e0fb03670c99ea/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 169

{
  "body" : {
    "_meta" : {
      "name" : "slot",
      "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
    }
  },
  "label" : "Simple Slot"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:44 GMT
Location: https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "slot",
      "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
    }
  },
  "version" : 1,
  "label" : "Simple Slot",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:44.790Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:44.790Z",
  "deliveryId" : "2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ce446e0fb03670c99ea"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3/workflow"
    }
  }
}

Associating Slots to Editions

Once you have a Slot Repository with some Slots you can then associate them with an Edition in order make them available for publishing.

  • Multiple Slots can be associated to an Edition, up to 200.

  • A Slot can be associated with multiple Editions.

  • A Slot can only be associated to an Edition once

When you associate Slots to an Edition, the slotsRemaining property on the Edition will decrease. If you attempt to associate more Slots than there are remaining on the Edition, the operation will fail.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

POST /v2/content/editions/5d722ce646e0fb03670c9aba/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 167

[ {
  "slot" : "c773eb52-e903-4b40-a3c2-305f0941f7e5"
}, {
  "slot" : "b084017c-717a-4837-bd26-e69e6511a7ae"
}, {
  "slot" : "ab5c2d29-cd4c-477f-9a79-dbe500f87c1a"
} ]

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6076

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5d722ce646e0fb03670c9abf",
      "eventId" : "5d722ce646e0fb03670c9ab9",
      "editionId" : "5d722ce646e0fb03670c9aba",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:46.517Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:46.517Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9ab8",
      "slotId" : "c773eb52-e903-4b40-a3c2-305f0941f7e5",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abf"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abf"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c773eb52-e903-4b40-a3c2-305f0941f7e5{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abf/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abf/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722ce646e0fb03670c9ac0",
      "eventId" : "5d722ce646e0fb03670c9ab9",
      "editionId" : "5d722ce646e0fb03670c9aba",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:46.517Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:46.517Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9ab8",
      "slotId" : "b084017c-717a-4837-bd26-e69e6511a7ae",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9ac0"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9ac0"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b084017c-717a-4837-bd26-e69e6511a7ae{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9ac0/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9ac0/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722ce646e0fb03670c9abe",
      "eventId" : "5d722ce646e0fb03670c9ab9",
      "editionId" : "5d722ce646e0fb03670c9aba",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:46.516Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:46.516Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9ab8",
      "slotId" : "ab5c2d29-cd4c-477f-9a79-dbe500f87c1a",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abe"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abe"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ab5c2d29-cd4c-477f-9a79-dbe500f87c1a{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abe/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots/5d722ce646e0fb03670c9abe/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aba/slots?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Retrieving Slots associated to an Edition

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/editions/5d722ce646e0fb03670c9aad/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6076

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5d722ce646e0fb03670c9ab3",
      "eventId" : "5d722ce646e0fb03670c9aac",
      "editionId" : "5d722ce646e0fb03670c9aad",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:04.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:04.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9aab",
      "slotId" : "f0fb83ff-88d3-48cc-b7db-f82f0ba213a0",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab3"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab3"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f0fb83ff-88d3-48cc-b7db-f82f0ba213a0{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab3/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab3/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722ce646e0fb03670c9ab1",
      "eventId" : "5d722ce646e0fb03670c9aac",
      "editionId" : "5d722ce646e0fb03670c9aad",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:03.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:03.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9aab",
      "slotId" : "4bbdbf3b-7595-4f3c-8ad5-156632597782",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab1"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab1"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4bbdbf3b-7595-4f3c-8ad5-156632597782{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab1/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9ab1/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722ce646e0fb03670c9aaf",
      "eventId" : "5d722ce646e0fb03670c9aac",
      "editionId" : "5d722ce646e0fb03670c9aad",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:02.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:02.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce646e0fb03670c9aab",
      "slotId" : "1786798e-cc39-40c4-af11-e61e25149fb9",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9aaf"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9aaf"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1786798e-cc39-40c4-af11-e61e25149fb9{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9aaf/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots/5d722ce646e0fb03670c9aaf/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce646e0fb03670c9aad/slots?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Retrieving Slots associated to an Edition filter by content item

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/editions/5d722ce546e0fb03670c9a4d/slots?includedSlots=92c8f3a5-72e2-4fe3-9d26-45ab9449b595 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2553

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5d722ce546e0fb03670c9a4e",
      "eventId" : "5d722ce546e0fb03670c9a49",
      "editionId" : "5d722ce546e0fb03670c9a4d",
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:45.453Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-09-06T09:54:45.453Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d722ce546e0fb03670c9a48",
      "slotId" : "92c8f3a5-72e2-4fe3-9d26-45ab9449b595",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots/5d722ce546e0fb03670c9a4e"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots/5d722ce546e0fb03670c9a4e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92c8f3a5-72e2-4fe3-9d26-45ab9449b595{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots/5d722ce546e0fb03670c9a4e/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots/5d722ce546e0fb03670c9a4e/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots?includedSlots=92c8f3a5-72e2-4fe3-9d26-45ab9449b595&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots?includedSlots=92c8f3a5-72e2-4fe3-9d26-45ab9449b595&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce546e0fb03670c9a4d/slots?includedSlots=92c8f3a5-72e2-4fe3-9d26-45ab9449b595&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Retrieving an single Slot associated to an Edition

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/editions/5d722cd446e0fb03670c9920/slots/5d722cd446e0fb03670c9922 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Mon, 05 Jun 2017 04:03:02 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1652

{
  "id" : "5d722cd446e0fb03670c9922",
  "eventId" : "5d722cd446e0fb03670c991f",
  "editionId" : "5d722cd446e0fb03670c9920",
  "createdBy" : "user",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2017-06-05T04:03:02.000Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d722cd446e0fb03670c991e",
  "slotId" : "f3902f0b-0eba-48e6-8903-e7baabb3cb1f",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c9920/slots/5d722cd446e0fb03670c9922"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c9920/slots/5d722cd446e0fb03670c9922"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c9920"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f3902f0b-0eba-48e6-8903-e7baabb3cb1f{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c9920/slots/5d722cd446e0fb03670c9922/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722cd446e0fb03670c9920/slots/5d722cd446e0fb03670c9922/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Removing the association between a Slot and an Edition

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request
DELETE /v2/content/editions/5d722ce646e0fb03670c9b17/slots/5d722ce646e0fb03670c9b19 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Associating Snapshots to Slots

A slot is a placeholder for one or more snapshots. In order to associate those snapshots to this slot you will need to post the resulting content item to the slot url.

Notice that in the below request, body.slot.id is the path to a snapshot. Not a content item.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

PUT /v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec/content HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 525

{
  "body" : {
    "_meta" : {
      "name" : "slot",
      "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
    },
    "slot" : {
      "_meta" : {
        "schema" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link",
        "rootContentItemId" : "64d4721f-20f4-4bc5-b4e9-c93a2562d68f",
        "locked" : true
      },
      "id" : "5d722ce446e0fb03670c99f2",
      "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    }
  },
  "label" : "Simple Slot"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:45 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5d722ce446e0fb03670c99ec",
  "eventId" : "5d722ce446e0fb03670c99e6",
  "editionId" : "5d722ce446e0fb03670c99e7",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:44.825Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:45.077Z",
  "content" : {
    "body" : {
      "_meta" : {
        "name" : "slot",
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
      },
      "slot" : {
        "_meta" : {
          "schema" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link",
          "rootContentItemId" : "64d4721f-20f4-4bc5-b4e9-c93a2562d68f",
          "locked" : true
        },
        "id" : "5d722ce446e0fb03670c99f2",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d722ce446e0fb03670c99e9",
  "slotId" : "2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

If you then retrieve the slot for that edition it will contain the content item posted previously.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:45 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5d722ce446e0fb03670c99ec",
  "eventId" : "5d722ce446e0fb03670c99e6",
  "editionId" : "5d722ce446e0fb03670c99e7",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:44.825Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:45.077Z",
  "content" : {
    "body" : {
      "_meta" : {
        "name" : "slot",
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
      },
      "slot" : {
        "_meta" : {
          "schema" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link",
          "rootContentItemId" : "64d4721f-20f4-4bc5-b4e9-c93a2562d68f",
          "locked" : true
        },
        "id" : "5d722ce446e0fb03670c99f2",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d722ce446e0fb03670c99e9",
  "slotId" : "2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f375e5e-4181-4d0f-b3a6-ecefa8a7fff3{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99e7/slots/5d722ce446e0fb03670c99ec/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

The body.slot.id can also be set to null when the user hasn’t currently assigned all of the fields. The service will accept this data, however the valid field will be set to false.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:EDITION:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

GET /v2/content/editions/5d722ce446e0fb03670c99de/slots/5d722ce446e0fb03670c99e3 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:54:44 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1702

{
  "id" : "5d722ce446e0fb03670c99e3",
  "eventId" : "5d722ce446e0fb03670c99dd",
  "editionId" : "5d722ce446e0fb03670c99de",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:54:44.465Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:54:44.549Z",
  "content" : {
    "body" : {
      "_meta" : {
        "name" : "slot",
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json"
      },
      "slot" : null
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d722ce446e0fb03670c99e0",
  "slotId" : "b8fa2cd7-ebbc-457f-91d9-eb01abaf17bd",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99de/slots/5d722ce446e0fb03670c99e3"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99de/slots/5d722ce446e0fb03670c99e3"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99de"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b8fa2cd7-ebbc-457f-91d9-eb01abaf17bd{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99de/slots/5d722ce446e0fb03670c99e3/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722ce446e0fb03670c99de/slots/5d722ce446e0fb03670c99e3/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Snapshot

A Snapshot is an immutable representation of a content item with all of its descendants (including their versions) at a given point in time.

Creating a new Snapshot

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5d722d4f46e0fb03670cb9c2/snapshots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 159

{
  "type" : "USER",
  "comment" : "This is an example snapshot.",
  "contentRoot" : "db375a2f-fd0b-49d3-ad71-cc6333f0e0b4",
  "createdFrom" : "content-item"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5d722d4f46e0fb03670cb9c9",
  "comment" : "This is an example snapshot.",
  "createdDate" : "2017-06-05T04:03:02Z",
  "createdBy" : "thor",
  "createdFrom" : "content-item",
  "type" : "USER",
  "meta" : [ ],
  "taggedEditions" : [ ],
  "locale" : null,
  "rootContentItem" : {
    "label" : "Banner Ad Homepage",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "id" : "db375a2f-fd0b-49d3-ad71-cc6333f0e0b4"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4f46e0fb03670cb9c2"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/db375a2f-fd0b-49d3-ad71-cc6333f0e0b4"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb9c9/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d4746e0fb03670cb017/snapshots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4205

{
  "_embedded" : {
    "snapshots" : [ {
      "id" : "5d722d4846e0fb03670cb01e",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-09-06T09:56:24.087Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "locale" : null,
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "721db178-b2ac-49d1-9034-9d3f27d0c5ab"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/721db178-b2ac-49d1-9034-9d3f27d0c5ab"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01e/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d722d4846e0fb03670cb01f",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-09-06T09:56:24.098Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "locale" : null,
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "e2e74353-b4ea-4611-bcb3-110091aaca11"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e2e74353-b4ea-4611-bcb3-110091aaca11"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb01f/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cb017/snapshots/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Retrieve a Snapshot by id

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/snapshots/5d722d4e46e0fb03670cb914 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5d722d4e46e0fb03670cb914",
  "comment" : "This is an example snapshot.",
  "createdDate" : "2017-10-09T08:07:06Z",
  "createdBy" : "user",
  "createdFrom" : "content-item",
  "type" : "USER",
  "meta" : [ ],
  "taggedEditions" : [ ],
  "locale" : null,
  "rootContentItem" : {
    "label" : "Banner Ad Homepage",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "id" : "203bebbb-ff20-4d76-ae62-4540a6336c99"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4e46e0fb03670cb90e"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/203bebbb-ff20-4d76-ae62-4540a6336c99"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4e46e0fb03670cb914/content-items{/id}",
      "templated" : true
    }
  }
}

A "Snapshot Edition link" is a reference between an snapshot and an edition. A snapshot can be linked to multiple editions.

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
POST /v2/content/snapshots/5d722d4946e0fb03670cb0ac/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

{
  "edition" : "5d722d4946e0fb03670cb0ab"
}
Example response
HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/snapshots/5d722d4946e0fb03670cb0ac/edition-links
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 396

{
  "editionId" : "5d722d4946e0fb03670cb0ab",
  "createdDate" : "2019-09-06T09:56:25Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d722d4946e0fb03670cb0ab"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4946e0fb03670cb0ac/edition-links/5d722d4946e0fb03670cb0ab"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
DELETE /v2/content/snapshots/5d722d4f46e0fb03670cb96e/edition-links/5d722d4f46e0fb03670cb96d HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/snapshots/5d722d4f46e0fb03670cb96e/edition-links/5d722d4f46e0fb03670cb96d

In order to get the list of Snapshot Edition Links for a given Snapshot, simply follow the HAL link with rel "snapshot-edition-links" on a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=1&size=5 HTTP/1.1
Accept: application/hal+json
Content-Type: application/json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3099

{
  "_embedded" : {
    "edition-links" : [ {
      "editionId" : "5d722d4846e0fb03670cb08c",
      "createdDate" : "2019-09-06T09:56:25Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d4846e0fb03670cb08c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links/5d722d4846e0fb03670cb08c"
        }
      }
    }, {
      "editionId" : "5d722d4846e0fb03670cb08d",
      "createdDate" : "2019-09-06T09:56:25Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d4846e0fb03670cb08d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links/5d722d4846e0fb03670cb08d"
        }
      }
    }, {
      "editionId" : "5d722d4846e0fb03670cb08e",
      "createdDate" : "2019-09-06T09:56:25Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d4846e0fb03670cb08e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links/5d722d4846e0fb03670cb08e"
        }
      }
    }, {
      "editionId" : "5d722d4846e0fb03670cb08f",
      "createdDate" : "2019-09-06T09:56:25Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d4846e0fb03670cb08f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links/5d722d4846e0fb03670cb08f"
        }
      }
    }, {
      "editionId" : "5d722d4846e0fb03670cb090",
      "createdDate" : "2019-09-06T09:56:25Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d722d4846e0fb03670cb090"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links/5d722d4846e0fb03670cb090"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4846e0fb03670cb086/edition-links?page=2&size=5"
    }
  },
  "page" : {
    "size" : 5,
    "totalElements" : 14,
    "totalPages" : 3,
    "number" : 1
  }
}

Publishing a Snapshot

In order to publish a snapshot follow the HAL link with the rel "create-publishing-job" on a Snapshot

Creating a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH

Required ACLs:
  • Hub - READ

Example request
POST /v2/content/snapshots/5d722d4646e0fb03670caf13/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-09-06T10:56:22.921Z"
}
Example response
HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caf14
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5d722d4646e0fb03670caf14",
  "scheduledDate" : "2019-09-06T10:56:22.921Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caf14"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caf14"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4646e0fb03670caf13"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caf14"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/publishing-jobs/5d722d4746e0fb03670caf6d HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5d722d4746e0fb03670caf6d",
  "scheduledDate" : "2019-09-06T11:56:23.016Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4746e0fb03670caf6c"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
    }
  }
}

Cancelling a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:PUBLISH

Required ACLs:
  • Hub - READ

Example request
PATCH /v2/content/publishing-jobs/5d722d4646e0fb03670caebb HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 27

{
  "state" : "CANCELLED"
}
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 560

{
  "id" : "5d722d4646e0fb03670caebb",
  "scheduledDate" : "2019-10-06T09:56:22.525Z",
  "createdDate" : "2019-09-06T09:56:22.536Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caebb"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4646e0fb03670caebb"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4646e0fb03670caeba"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/snapshots/5d722d4746e0fb03670caf6c/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1356

{
  "_embedded" : {
    "publishing-jobs" : [ {
      "id" : "5d722d4746e0fb03670caf6d",
      "scheduledDate" : "2019-09-06T11:56:23.016Z",
      "createdDate" : "2017-06-05T04:03:02.000Z",
      "createdBy" : "user",
      "state" : "CREATED",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
        },
        "publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4746e0fb03670caf6c"
        },
        "cancel" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d722d4746e0fb03670caf6d"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4746e0fb03670caf6c/publishing-jobs?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4746e0fb03670caf6c/publishing-jobs?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d722d4746e0fb03670caf6c/publishing-jobs?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Folders

Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository.

Creating a new Folder

To create a new folder follow the "create-folder" link from a content repository.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

POST /v2/content/content-repositories/5d722ccf46e0fb03670c9289/folders HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

{
  "name" : "A folder to end all folders"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1058

{
  "id" : "5d722cd046e0fb03670c928a",
  "name" : "A folder to end all folders",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9289"
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9289/content-items?folderId=5d722cd046e0fb03670c928a{&page,projection,size,sort,status}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a/folders"
    },
    "delete-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a"
    },
    "update-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c928a"
    }
  }
}

Creating a new sub folder

You can create a sub folder by following the "create-folder" link from a folder.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

POST /v2/content/folders/5d722cd046e0fb03670c9334/folders HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 48

{
  "name" : "A sub folder to end all folders"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1180

{
  "id" : "5d722cd046e0fb03670c9335",
  "name" : "A sub folder to end all folders",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c9333"
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c9333/content-items?folderId=5d722cd046e0fb03670c9335{&page,projection,size,sort,status}",
      "templated" : true
    },
    "parent-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9334"
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335/folders"
    },
    "delete-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335"
    },
    "update-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c9335"
    }
  }
}

Get a folder

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/folders/5d722ccf46e0fb03670c9236 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1058

{
  "id" : "5d722ccf46e0fb03670c9236",
  "name" : "A folder to end all folders",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9236"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9236"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9235"
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9235/content-items?folderId=5d722ccf46e0fb03670c9236{&page,projection,size,sort,status}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9236/folders"
    },
    "delete-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9236"
    },
    "update-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9236"
    }
  }
}

Delete a folder

To be able to delete a folder it must be empty of subfolders and content items

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:DELETE

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

DELETE /v2/content/folders/5d722ccf46e0fb03670c918d HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Get top-level folders in a repository

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5d722ccf46e0fb03670c91e0/folders HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3060

{
  "_embedded" : {
    "folders" : [ {
      "id" : "5d722ccf46e0fb03670c91e1",
      "name" : "A folder to end all folders",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e1"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e1"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/content-items?folderId=5d722ccf46e0fb03670c91e1{&page,projection,size,sort,status}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e1/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e1"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e1"
        }
      }
    }, {
      "id" : "5d722ccf46e0fb03670c91e2",
      "name" : "Another Folder",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e2"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e2"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/content-items?folderId=5d722ccf46e0fb03670c91e2{&page,projection,size,sort,status}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e2/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e2"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c91e2"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/folders?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/folders?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/folders?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c91e0/folders/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Get sub-folders of a folder

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/folders/5d722cd046e0fb03670c92de/folders HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3249

{
  "_embedded" : {
    "folders" : [ {
      "id" : "5d722cd046e0fb03670c92df",
      "name" : "Subfolder 1",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92df"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92df"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c92dd"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c92dd/content-items?folderId=5d722cd046e0fb03670c92df{&page,projection,size,sort,status}",
          "templated" : true
        },
        "parent-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de"
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92df/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92df"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92df"
        }
      }
    }, {
      "id" : "5d722cd046e0fb03670c92e0",
      "name" : "Subfolder 2",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92e0"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92e0"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c92dd"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d722cd046e0fb03670c92dd/content-items?folderId=5d722cd046e0fb03670c92e0{&page,projection,size,sort,status}",
          "templated" : true
        },
        "parent-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de"
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92e0/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92e0"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92e0"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de/folders?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de/folders?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de/folders?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722cd046e0fb03670c92de/folders/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Update a folder

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:FOLDER:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

PATCH /v2/content/folders/5d722ccf46e0fb03670c9139 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 25

{
  "name" : "New name"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1039

{
  "id" : "5d722ccf46e0fb03670c9139",
  "name" : "New name",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9138"
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722ccf46e0fb03670c9138/content-items?folderId=5d722ccf46e0fb03670c9139{&page,projection,size,sort,status}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139/folders"
    },
    "delete-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139"
    },
    "update-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d722ccf46e0fb03670c9139"
    }
  }
}

Localization

There are 2 methods of localizing your content into multiple languages, field-level localization and item-level localization. With field-level localization, your content type schema defines which values in your content can be translated into different languages. All translations exist as data in a single item. With item-level localization, you create separate copies of your content for each language.

Hub Localization Settings

In order to enable localization features for your Hub, you will need to add localization settings.

The first locale in the list will become the Hub’s master locale, which cannot be changed once set:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:HUB:EDIT

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request

PATCH /v2/content/hubs/5d722d5746e0fb03670cc331/settings HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 65

{
  "localization" : {
    "locales" : [ "en-GB", "fr-FR" ]
  }
}

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/hubs/5d722d5746e0fb03670cc331

Item-level localization

Assigning a locale to a Content Item

Once your Hub has been assigned some locales, you can assign one of those locales to your content. Note: Once, you have assigned a locale to a Content Item it can not be changed

You can either assign a locale to a Content Item when you create it, or to an existing item. See below for examples of both.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request
POST /v2/content/content-repositories/5d722d2846e0fb03670ca997/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 305

{
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label" : "Banner Ad Homepage",
  "locale" : "en-GB"
}
Example response
HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:52 GMT
Location: https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3928

{
  "id" : "0a37de43-4573-4f25-bac4-b57820523b25",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "locale" : "en-GB",
  "createdDate" : "2019-09-06T09:55:52.918Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:52.918Z",
  "deliveryId" : "0a37de43-4573-4f25-bac4-b57820523b25",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0a37de43-4573-4f25-bac4-b57820523b25"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2846e0fb03670ca997"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0a37de43-4573-4f25-bac4-b57820523b25",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0a37de43-4573-4f25-bac4-b57820523b25{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a37de43-4573-4f25-bac4-b57820523b25/workflow"
    }
  }
}
Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request
POST /v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/locale HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 41

{
  "locale" : "en-GB",
  "version" : 1
}
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3928

{
  "id" : "759048a4-887e-4d2f-bf3f-7f7e6a7639ea",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "locale" : "en-GB",
  "createdDate" : "2019-09-06T09:55:52.744Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:52.763Z",
  "deliveryId" : "759048a4-887e-4d2f-bf3f-7f7e6a7639ea",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=759048a4-887e-4d2f-bf3f-7f7e6a7639ea"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d2846e0fb03670ca98f"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=759048a4-887e-4d2f-bf3f-7f7e6a7639ea",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=759048a4-887e-4d2f-bf3f-7f7e6a7639ea{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/759048a4-887e-4d2f-bf3f-7f7e6a7639ea/workflow"
    }
  }
}

Localizing a content graph

Once your content items have been assigned a locale, you can prepare your content for translation by localizing a content item and all of it’s descendents into the desired target locale(s).

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:CREATE

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request
POST /v2/content/content-items/b7e6016b-baab-4cca-98a2-966a5a2914e4/localize HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 55

{
  "locales" : [ "fr-FR", "de-DE" ],
  "version" : 1
}
Example response
HTTP/1.1 202 Accepted
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 647

{
  "status" : "IN_PROGRESS",
  "rootContentItem" : {
    "label" : "l10n",
    "locale" : "en-GB",
    "id" : "b7e6016b-baab-4cca-98a2-966a5a2914e4"
  },
  "requestedLocales" : [ "fr-FR", "de-DE" ],
  "createdBy" : "user",
  "createdDate" : "2017-06-05T04:03:02.001Z",
  "_links" : {
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b7e6016b-baab-4cca-98a2-966a5a2914e4"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b7e6016b-baab-4cca-98a2-966a5a2914e4{&page,size,sort}",
      "templated" : true
    }
  }
}

This operation will create variants of the given content item (the root content item) and its descendants with the given locales. At present, the content items will not be translated automatically as part of this operation, but all created variants of a content item will be related to support quickly switching variants based on the desired locale.

If the request is successful, a localization job will be started which will create the necessary content items asynchronously. In order to start a localization job in this manner, the following conditions must be met:

  1. The source content item must have a locale

  2. The target locales must be supported by the hub

  3. A variant of the source content item must not already exist in any of the specified locales

  4. You must specify the current version of the source content item (similar to updating a content item)

A successful request will result in the creation of at least one new content item (a variant of the root content item). The localization job will attempt to preserve the structure of the content graph composed of the root content item and descendant content items. Content item variants created by this process will be placed adjacent to their source content item.

Content Item Graph Localization Examples

Where possible, graph structure will be preserved. Consider a request to localize a content item A from en-GB to an fr-FR variant A'. Item A and all descendant content items have the en-GB locale.

    A                       A                A'
   / \                     / \              / \
  B   C        ==>        B   C            B'  C'
 /   / \                 /   / \          /   / \
D   E   F               D   E   F        D'  E'  F'

Only content items which have a locale will have variants created. In the event that a content item in the graph does not have a locale, the newly created content graph will link back to the original un-localized item. Consider the request from the previous example, but this time item C does not have a locale.

    A                       A   A'
   / \                     / \ / \
  B   C        ==>        B   C   B'
 /   / \                 /   / \   \
D   E   F               D   E   F   D'

Note that the new fr-FR variant A' links to the un-localized content item C. If E and F have the en-GB locale, no fr-FR variant will be created for either of them since this would break the original graph structure, therefore it is advised to avoid having un-localized content items with localized children where possible.

If a content item variant already exists then it will be incorporated into the new content graph where possible. Consider the case where an fr-FR variant of C already exists - the newly created content graph will link to C' and preserve the original graph structure.

    A                                     A                A'
   / \                                   / \              / \
  B   C            C'        ==>        B   C            B'  C'
 /   / \          / \                  /   / \          /   / \
D   E   F        E'  F'               D   E   F        D'  E'  F'

Listing the localizations of a Content Item

Once a Content Item has been localized into one or more desired locales, you will be able to see the list of all localizations by following the "localizations" HAL link.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:READ

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/content-items/aed03fc8-b41a-4170-9d29-1611db8fbd89/localizations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1372

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "aed03fc8-b41a-4170-9d29-1611db8fbd89",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aed03fc8-b41a-4170-9d29-1611db8fbd89"
        }
      }
    }, {
      "id" : "9b2f1f01-8fd8-4fd2-86ca-1d6656197887",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b2f1f01-8fd8-4fd2-86ca-1d6656197887"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aed03fc8-b41a-4170-9d29-1611db8fbd89/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aed03fc8-b41a-4170-9d29-1611db8fbd89/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aed03fc8-b41a-4170-9d29-1611db8fbd89/localizations?page=0&size=20&sort=createdDate,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

Localization Jobs

Content item localization is performed asynchronously - the request to localize a content item graph creates a Localization Job which will be completed at some point in the future. It is possible to track the status of these jobs as follows:

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/localization-jobs/search/findByRootContentItem?id=adb50d74-0f9d-4192-80a4-17a0e11a6ee8 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1553

{
  "_embedded" : {
    "localization-jobs" : [ {
      "status" : "IN_PROGRESS",
      "rootContentItem" : {
        "label" : "l10n",
        "locale" : "en-GB",
        "id" : "adb50d74-0f9d-4192-80a4-17a0e11a6ee8"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-09-06T09:54:26.719Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/adb50d74-0f9d-4192-80a4-17a0e11a6ee8"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=adb50d74-0f9d-4192-80a4-17a0e11a6ee8{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=adb50d74-0f9d-4192-80a4-17a0e11a6ee8&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=adb50d74-0f9d-4192-80a4-17a0e11a6ee8&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=adb50d74-0f9d-4192-80a4-17a0e11a6ee8&page=0&size=20"
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Localization jobs can have the following status codes:

Table 4. Localization Job Status
Status Description

IN_PROGRESS

The localization job is still in progress. Some content item variants may have already been created.

SUCCEEDED

The localization job has been completed successfully.

PARTIALLY_SUCCEEDED

The localization job created at least one content item variant successfully, but the full graph will not have been localized.

FAILURE

The localization job was unsuccessful

When tracking localization jobs for a particular content graph, the root content item ID must be provided as the query parameter, providing child IDs will give no results. Localization jobs will be tracked against the root content item and all locale variants, so if more than one locale variant of the root content item exists, using any of the IDs will give the same localization job results.

Assigning a set of locales to a Content Repository

In order to organise your localized content into separate repositories you can assign a set locales to a Content Repository. You may want to do this in order to give different teams different permissions to create or edit content based on locale.

Assigning locales to a Content Repository has 2 effects. Firstly, you will only be able to assign locales to Content Items which match those assigned to the repository. Secondly, when localizing a content graph, the newly created Content Items will be created in the appropriate Content Repository which match the desired locale.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request
PATCH /v2/content/content-repositories/5d722d4446e0fb03670cacbf/item-locales HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 36

{
  "itemLocales" : [ "en", "fr" ]
}
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3155

{
  "id" : "5d722d4446e0fb03670cacbf",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cacbe"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cacbe/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4446e0fb03670cacbe/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/features?feature={feature}",
      "templated" : true
    },
    "update-content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4446e0fb03670cacbf/localization-group/locales"
    }
  }
}

Joining a Content Repository to a localization group

The following API allows you to make 2 or more Content Repositories part of the same "group". The new repository will leave it’s current group and join the group of the target repository. To do this, follow the "join-localization-group" HAL link from the target repository and specify the new repository in the body.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request
POST /v2/content/content-repositories/5d722d4446e0fb03670cac6b/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "newRepositoryId" : "5d722d4446e0fb03670cac69"
}
Example response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

For example, lets say you have 3 Content Repositories, Repo1 has no locales assigned, Repo2 and Repo3 are both members of the same group and are assigned locales ["en-GB", "en-US"] and ["fr-FR"] respectively. The following example shows localizing en-GB content into fr-FR. A1 signifies that item A exists in Repo1.

    A1                   A1              A'1
   /  \                 /  \             / \
  B2   C1      ==>     B2   C1         B'3  C'1
 /    /  \            /    /  \        /    / \
D2   E2   F2         D2   E2   F2    D'3  E'3  F'3

Note that the new fr-FR variant A' still exists in Repo1, whereas B' is created in Repo3.

Listing all item locales in a Content Repository localization group

A list of all supported item locales in a Content Repository localization group can be requested as follows:

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:REPOSITORY:READ

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/content-repositories/5d722d4546e0fb03670cad6a/localization-group/locales HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 224

{
  "locales" : [ "de", "en", "en-GB", "en-NZ", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d722d4546e0fb03670cad6a/localization-group/locales"
    }
  }
}

This request can be made using the ID of any repository in the localization group.

Administration

Listing Administrative Operations

To list the available administrative operations available to you, navigate the "admin" link from the root of the API. It will return a list of links to other resources which will allow you to perform the desired operation.

The following operations are available based on your permissions

Table 5. Operations
Operation rel

Manage Access

"access"

Auth rules

Required Functional Permissions:
  • none

Example request

GET /v2/content/admin HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 194

{
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin"
    },
    "access" : {
      "href" : "https://api.amplience.net/v2/content/admin/access"
    }
  }
}

Managing Access

With the ability to manage access you can control which users have which permissions to the resources you administer. In order to see which resource types you can manage, follow the "access" link.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

Example request

GET /v2/content/admin/access HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 389

{
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/{id}",
      "templated" : true
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/{id}",
      "templated" : true
    }
  }
}

Listing operations for a resource

Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.

For example, to see the operations you can perform on a particular Hub:

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/hubs/5d722ce946e0fb03670c9d73 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 431

{
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce946e0fb03670c9d73"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce946e0fb03670c9d73/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce946e0fb03670c9d73/members/{sid}",
      "templated" : true
    }
  }
}

And to see the operations you can perform on a particular Content Repository:

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • ContentRepository - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9d71 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 479

{
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9d71"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9d71/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9d71/members/{sid}",
      "templated" : true
    }
  }
}

Listing members on a resource

In order to see who has access to a particular resource follow the "members" link. This will also show you the member id (sid) and list the permissions they have on the given resource

For example, to list the members of a Hub:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request

GET /v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2645

{
  "_embedded" : {
    "members" : [ {
      "sid" : "alice",
      "permissions" : [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_REPOSITORY", "CREATE_EVENT", "EDIT_EVENT", "DELETE_EVENT", "CREATE_EDITION", "EDIT_EDITION", "DELETE_EDITION", "MANAGE_ACCESS", "EDIT_WORKFLOW_STATES" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce846e0fb03670c9c77/members"
    }
  }
}

And to list the members of a Content Repository:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • ContentRepository - MANAGE_ACCESS

Example request

GET /v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2727

{
  "_embedded" : {
    "members" : [ {
      "sid" : "alice",
      "permissions" : [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_CONTENT", "EDIT_CONTENT", "DELETE_CONTENT", "MANAGE_ACCESS" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_CONTENT" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d722ce946e0fb03670c9c7a/members"
    }
  }
}

Get a member by id

Given a resource and a member id you can navigate directly to a specific member by following the "member" link from the resource.

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request

GET /v2/content/admin/access/hubs/5d722ce946e0fb03670c9dc5/members/alice HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 400

{
  "sid" : "alice",
  "permissions" : [ "READ" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce946e0fb03670c9dc5/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d722ce946e0fb03670c9dc5/members/alice/permissions/{permission}",
      "templated" : true
    }
  }
}

Revoking permission

You can revoke access to a specific resource by deleting a members permission. From a member, you can follow the "revoke-permission" link passing in the permission to delete. You can specify one or multiple permissions. Multiple permissions are comma separated.

For example, to delete a single permission:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request

DELETE /v2/content/admin/access/hubs/5d722ce946e0fb03670c9ccc/members/alice/permissions/EDIT HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

To delete multiple permissions:

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request

DELETE /v2/content/admin/access/hubs/5d722ce946e0fb03670c9cce/members/alice/permissions/READ,EDIT HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Webhooks

A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST.

Creating a new Webhook for a Hub

Supported event names that will be accepted by the events array when creating a new webhook:

Event name Event label

dynamic-content.snapshot.published

Snapshot - published

dynamic-content.edition.scheduled

Edition - scheduled

dynamic-content.edition.unscheduled

Edition - unscheduled

dynamic-content.edition.published

Edition - published

dynamic-content.content-item.created

Content item - created

dynamic-content.content-item.updated

Content item - updated

dynamic-content.content-item.workflow.updated

Content item workflow - updated

For more information on using webhooks see https://docs.amplience.net/integration/webhooks.html

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:CREATE

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 297

{
  "label" : "my-subscription",
  "events" : [ "dynamic-content.edition.scheduled", "dynamic-content.edition.unscheduled" ],
  "handlers" : [ "http://example.com/webhook" ],
  "active" : true,
  "secret" : "my-subscription-secret",
  "notifications" : [ {
    "email" : "test@example.com"
  } ]
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Location: https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/5a497a000000000000000000
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1305

{
  "id" : "5a497a000000000000000000",
  "label" : "myWebhookSubscription",
  "events" : [ "dynamic-content.edition.scheduled", "dynamic-content.edition.unscheduled" ],
  "active" : true,
  "handlers" : [ "http://example.com/webhook" ],
  "notifications" : [ {
    "email" : "test@example.com"
  } ],
  "secret" : "my-subscription-secret",
  "createdDate" : "2018-01-02T03:04:05Z",
  "lastModifiedDate" : "2018-01-02T03:04:05Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b73/webhooks/5a497a000000000000000000"
    }
  }
}

Listing all Webhooks for a Hub

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks?size=3&sort=createdDate,asc HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4698

{
  "_embedded" : {
    "webhooks" : [ {
      "id" : "5a497a000000000000000001",
      "events" : [ "dynamic-content.edition.published" ],
      "active" : true,
      "handlers" : [ "http://example.com/webhook" ],
      "secret" : "secret",
      "createdDate" : "2018-01-02T03:04:05Z",
      "lastModifiedDate" : "2018-01-02T03:04:05Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000001"
        }
      }
    }, {
      "id" : "5a497a000000000000000002",
      "events" : [ "dynamic-content.edition.published" ],
      "active" : true,
      "handlers" : [ "http://example.com/webhook" ],
      "secret" : "secret",
      "createdDate" : "2018-01-02T03:04:05Z",
      "lastModifiedDate" : "2018-01-02T03:04:05Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000002"
        }
      }
    }, {
      "id" : "5a497a000000000000000003",
      "events" : [ "dynamic-content.edition.published" ],
      "active" : true,
      "handlers" : [ "http://example.com/webhook" ],
      "secret" : "secret",
      "createdDate" : "2018-01-02T03:04:05Z",
      "lastModifiedDate" : "2018-01-02T03:04:05Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b6d/webhooks/event-types"
    }
  },
  "page" : {
    "size" : 3,
    "totalElements" : 6,
    "totalPages" : 2,
    "number" : 0
  }
}

Listing all Requests for a Webhook

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5700

{
  "_embedded" : {
    "requests" : [ {
      "id" : "561859fa-a496-43f4-818a-ed787a5d5d97",
      "eventId" : "4cac0437-e6d7-42ba-b58f-c52931895f21",
      "eventName" : "dynamic-content.edition.scheduled",
      "requestState" : "SUCCESS",
      "attempts" : 1,
      "invocations" : [ {
        "request" : {
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "headers" : [ "Connection: close", "Server: gunicorn/19.8.1", "Date: Tue, 15 May 2018 12:07:13 GMT", "Content-Type: application/json", "Content-Length: 3", "Access-Control-Allow-Origin: *", "Access-Control-Allow-Credentials: true", "Via: 1.1 vegur" ],
          "body" : "..."
        }
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    }, {
      "id" : "06f89aa1-3309-4800-a546-9af5853d33fd",
      "eventId" : "4cac0437-e6d7-42ba-b58f-c52931895f21",
      "eventName" : "dynamic-content.edition.scheduled",
      "requestState" : "SUCCESS",
      "attempts" : 1,
      "invocations" : [ {
        "request" : {
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "body" : "{\"sequenceId\":2,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "headers" : [ "Connection: close", "Server: gunicorn/19.8.1", "Date: Tue, 15 May 2018 12:07:13 GMT", "Content-Type: application/json", "Content-Length: 3", "Access-Control-Allow-Origin: *", "Access-Control-Allow-Credentials: true", "Via: 1.1 vegur" ],
          "body" : "..."
        }
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    }, {
      "id" : "aad0db85-9af5-41e5-b761-95081e50a69d",
      "eventId" : "4cac0437-e6d7-42ba-b58f-c52931895f21",
      "eventName" : "dynamic-content.edition.scheduled",
      "requestState" : "SUCCESS",
      "attempts" : 1,
      "invocations" : [ {
        "request" : {
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "headers" : [ "Connection: close", "Server: gunicorn/19.8.1", "Date: Tue, 15 May 2018 12:07:13 GMT", "Content-Type: application/json", "Content-Length: 3", "Access-Control-Allow-Origin: *", "Access-Control-Allow-Credentials: true", "Via: 1.1 vegur" ],
          "body" : "..."
        }
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce846e0fb03670c9bd1/webhooks/5a497a000000000000000000/requests?cursor=CURSOR&limit=20"
    }
  }
}

Get a Webhook

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:READ

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/5a497a000000000000000000 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1211

{
  "id" : "5a497a000000000000000000",
  "label" : "myWebhookSubscription",
  "events" : [ "dynamic-content.edition.scheduled" ],
  "active" : true,
  "handlers" : [ "http://example.com/webhook" ],
  "notifications" : [ ],
  "secret" : "secret",
  "createdDate" : "2018-01-02T03:04:05Z",
  "lastModifiedDate" : "2018-01-02T03:04:05Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b7d/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:EDIT

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/5a497a000000000000000000 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 261

{
  "label" : "new-label",
  "active" : false,
  "handlers" : [ "http://example.com/updated-webhook" ],
  "events" : [ "dynamic-content.edition.scheduled", "dynamic-content.edition.unscheduled" ],
  "notifications" : [ {
    "email" : "test@example.com"
  } ]
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1286

{
  "id" : "5a497a000000000000000000",
  "label" : "new-label",
  "events" : [ "dynamic-content.edition.scheduled", "dynamic-content.edition.unscheduled" ],
  "active" : false,
  "handlers" : [ "http://example.com/updated-webhook" ],
  "notifications" : [ {
    "email" : "test@example.com"
  } ],
  "secret" : "secret",
  "createdDate" : "2018-01-02T03:04:05Z",
  "lastModifiedDate" : "2018-01-02T03:04:05Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722ce746e0fb03670c9b71/webhooks/5a497a000000000000000000"
    }
  }
}

Deleting a Webhook

Auth rules

Required Functional Permissions:
  • CONTENT:FUNCTIONAL:WEBHOOK:DELETE

Required ACLs:
  • Hub - READ

Example request

DELETE /v2/content/hubs/5d722ce746e0fb03670c9b7b/webhooks/5a497a000000000000000000 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Workflows

It is possible to define a list of workflow states on a hub which will allow users to implement one or more rudimentary workflows. Each content item within the hub can have it’s status set to one of the workflow states defined within the hub.

In the interest of flexibility, the transitions between states are not validated. In other words, it is possible to transition a content item from any state into any other state.

for more information on adding a workflow to a contentItem see Assigning a workflow

Creating a Workflow State

You may create up to 100 workflow states per hub.

The color property is an RGB value representing the color which should be used to display the workflow state within Dynamic Content. A value for color must be provided.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - EDIT_WORKFLOW_STATES

Example request

POST /v2/content/hubs/5d722d0e46e0fb03670ca4a1/workflow-states HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 57

{
  "label" : "Testing",
  "color" : "rgb(255,255,255)"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Tue, 02 Jan 2018 03:04:05 GMT
Location: https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca4a2
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 731

{
  "id" : "5d722d0e46e0fb03670ca4a2",
  "label" : "Testing",
  "createdBy" : "user",
  "createdDate" : "2018-01-02T03:04:05.000Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2018-01-02T03:04:05.000Z",
  "color" : "rgb(255,255,255)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca4a2"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca4a2"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca4a1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca4a2"
    }
  }
}

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d722d0e46e0fb03670ca44c/workflow-states HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3107

{
  "_embedded" : {
    "workflow-states" : [ {
      "id" : "5d722d0e46e0fb03670ca44e",
      "label" : "In Progress",
      "createdBy" : "user",
      "createdDate" : "2018-01-02T06:04:05.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-01-02T06:04:05.000Z",
      "color" : "rgb(150,200,250)",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44e"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44e"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44e"
        }
      }
    }, {
      "id" : "5d722d0e46e0fb03670ca44f",
      "label" : "Done",
      "createdBy" : "user",
      "createdDate" : "2018-01-02T05:04:05.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-01-02T05:04:05.000Z",
      "color" : "rgb(255,255,255)",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44f"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44f"
        }
      }
    }, {
      "id" : "5d722d0e46e0fb03670ca44d",
      "label" : "To Do",
      "createdBy" : "user",
      "createdDate" : "2018-01-02T03:04:05.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-01-02T03:04:05.000Z",
      "color" : "rgb(0,50,100)",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44d"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0e46e0fb03670ca44d"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0e46e0fb03670ca44c/workflow-states?page=0&size=20&sort=createdDate,desc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get a Workflow State

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/workflow-states/5d722d0f46e0fb03670ca5a1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 06 Sep 2019 09:55:27 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 729

{
  "id" : "5d722d0f46e0fb03670ca5a1",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2019-09-06T09:55:27.517Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-09-06T09:55:27.517Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca5a1"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca5a1"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0f46e0fb03670ca5a0"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca5a1"
    }
  }
}

Update a Workflow State

You may update the label or color for any workflow state attached to your hub or hubs.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - EDIT_WORKFLOW_STATES

Example request

PATCH /v2/content/workflow-states/5d722d0f46e0fb03670ca54e HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "label" : "done",
  "color" : "rgb(255,0,255)"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 726

{
  "id" : "5d722d0f46e0fb03670ca54e",
  "label" : "done",
  "createdBy" : "user",
  "createdDate" : "2018-01-02T03:04:05.000Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2018-02-03T04:05:06.000Z",
  "color" : "rgb(255,0,255)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca54e"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca54e"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d0f46e0fb03670ca54d"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d722d0f46e0fb03670ca54e"
    }
  }
}

Integrations

Salesforce Commerce Cloud (SFCC) Integration

For more information please refer to our Salesforce Commerce Cloud integration documentation.

Listing the Salesforce Commerce Cloud (SFCC) Integrations

To list all of the SFCC integrations for a Hub, follow the "list-integrations" HAL link of the "sfcc" integration.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:INTEGRATIONS:READ

  • PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:READ

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/hubs/5d722d4746e0fb03670cafc1/integrations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1052

{
  "_embedded" : {
    "integrations" : [ {
      "type" : "sfcc",
      "label" : "Salesforce Commerce Cloud",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc?hubId=5d722d4746e0fb03670cafc1"
        },
        "list-integrations" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc?hubId=5d722d4746e0fb03670cafc1{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc1/integrations?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc1/integrations?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc1/integrations?page=0&size=20&sort=label,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Creating a new Salesforce Commerce Cloud (SFCC) Integration

To create a new SFCC Integration, invoke the "create-integration" HAL link of the "sfcc" integration.

Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:INTEGRATIONS:READ

  • PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:CREATE

  • CONTENT:FUNCTIONAL:WEBHOOK:CREATE

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/hubs/5d722d4746e0fb03670cafc5/integrations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 975

{
  "_embedded" : {
    "integrations" : [ {
      "type" : "sfcc",
      "label" : "Salesforce Commerce Cloud",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc?hubId=5d722d4746e0fb03670cafc5"
        },
        "create-integration" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc5/integrations?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc5/integrations?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d722d4746e0fb03670cafc5/integrations?page=0&size=20&sort=label,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}