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: Thu, 28 Nov 2019 13:15:36 GMT
Location: https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4398

{
  "id" : "5ddfc87846e0fb03956c1bc0",
  "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-11-28T13:15:36.789Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:36.789Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/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/5ddfc87846e0fb03956c1bc0/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87846e0fb03956c1bc0/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" : "5ddfc87746e0fb03956c19c2",
      "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-11-28T13:15:35.537Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:35.537Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/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/5ddfc87746e0fb03956c19c2/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c2/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc87746e0fb03956c19c4",
      "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-11-28T13:15:35.591Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:35.591Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/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/5ddfc87746e0fb03956c19c4/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c4/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc87746e0fb03956c19c6",
      "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-11-28T13:15:35.644Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:35.644Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/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/5ddfc87746e0fb03956c19c6/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c19c6/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/5ddfc8b746e0fb03956c336b 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: Thu, 28 Nov 2019 13:16:39 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5494

{
  "id" : "5ddfc8b746e0fb03956c336b",
  "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-11-28T13:16:39.640Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:16:39.640Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "extensions" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/extensions{?page,size,sort}",
      "templated" : true
    },
    "extensions-lite" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/extensions?show-full=false{&page,size,sort}",
      "templated" : true
    },
    "extension-by-name" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/extensions/{name}",
      "templated" : true
    },
    "create-extension" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/extensions"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/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/5ddfc8b746e0fb03956c336b/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/webhooks"
    },
    "integrations" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/integrations{?page,size,sort}",
      "templated" : true
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b746e0fb03956c336b/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/5ddfc87746e0fb03956c196e 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: Thu, 28 Nov 2019 13:15:35 GMT
Location: https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4402

{
  "id" : "5ddfc87746e0fb03956c196e",
  "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-11-28T13:15:35.305Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:35.367Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/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/5ddfc87746e0fb03956c196e/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc87746e0fb03956c196e/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/5ddfc8b746e0fb03956c33bf/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/5ddfc8b746e0fb03956c33bf

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/5ddfc8b746e0fb03956c33c1/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/5ddfc8b746e0fb03956c33c1

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

POST /v2/content/hubs/5ddfc87546e0fb03956c17ca/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/5ddfc88e46e0fb03956c2711/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/5ddfc88e46e0fb03956c2714
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1241

{
  "id" : "5ddfc88e46e0fb03956c2714",
  "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/5ddfc88e46e0fb03956c2714"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88e46e0fb03956c2714"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88e46e0fb03956c2714/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88e46e0fb03956c2714/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88e46e0fb03956c2714"
    }
  }
}

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/5ddfc91246e0fb03956c5537/content-types HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "contentTypeId" : "5ddfc91246e0fb03956c5536"
}

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" : "5ddfc91246e0fb03956c5537",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ {
    "hubContentTypeId" : "5ddfc91246e0fb03956c5536",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
  } ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c5533"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c5533/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c5533/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/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/5ddfc91246e0fb03956c5537/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c5537/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/5ddfc91346e0fb03956c558f/content-types/5ddfc91346e0fb03956c558e 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" : "5ddfc91346e0fb03956c558f",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c558b"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c558b/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c558b/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/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/5ddfc91346e0fb03956c558f/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91346e0fb03956c558f/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/5ddfc88d46e0fb03956c25af/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: 4877

{
  "_embedded" : {
    "content-types" : [ {
      "id" : "5ddfc88d46e0fb03956c25b2",
      "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/5ddfc88d46e0fb03956c25b2"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b2"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b2/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b2/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b2"
        }
      }
    }, {
      "id" : "5ddfc88d46e0fb03956c25b4",
      "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/5ddfc88d46e0fb03956c25b4"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b4"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b4/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b4/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b4"
        }
      }
    }, {
      "id" : "5ddfc88d46e0fb03956c25b6",
      "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/5ddfc88d46e0fb03956c25b6"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b6"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b6/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b6/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c25b6"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88d46e0fb03956c25af/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88d46e0fb03956c25af/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88d46e0fb03956c25af/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88d46e0fb03956c25af/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/5ddfc88d46e0fb03956c255b 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: 1241

{
  "id" : "5ddfc88d46e0fb03956c255b",
  "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/5ddfc88d46e0fb03956c255b"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c255b"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c255b/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c255b/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88d46e0fb03956c255b"
    }
  }
}

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/5ddfc88c46e0fb03956c2504 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/5ddfc88c46e0fb03956c2504
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1133

{
  "id" : "5ddfc88c46e0fb03956c2504",
  "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/5ddfc88c46e0fb03956c2504"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88c46e0fb03956c2504"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88c46e0fb03956c2504/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88c46e0fb03956c2504/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5ddfc88c46e0fb03956c2504"
    }
  }
}

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/5ddfc88e46e0fb03956c26bd/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" : "5ddfc88e46e0fb03956c26ba",
  "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/5ddfc88e46e0fb03956c26bd/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/5ddfc88e46e0fb03956c2664/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" : "5ddfc88d46e0fb03956c2661",
  "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/5ddfc88e46e0fb03956c2664/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/5ddfc88b46e0fb03956c22ac/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/5ddfc88b46e0fb03956c22ad
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

{
  "id" : "5ddfc88b46e0fb03956c22ad",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c22ac"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c22ac/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c22ac/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/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/5ddfc88b46e0fb03956c22ad/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c22ad/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/5ddfc88b46e0fb03956c2356/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" : "5ddfc88b46e0fb03956c2357",
      "name" : "repo1",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/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/5ddfc88b46e0fb03956c2357/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2357/localization-group/locales"
        }
      }
    }, {
      "id" : "5ddfc88b46e0fb03956c2358",
      "name" : "repo2",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/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/5ddfc88b46e0fb03956c2358/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2358/localization-group/locales"
        }
      }
    }, {
      "id" : "5ddfc88b46e0fb03956c2359",
      "name" : "repo3",
      "label" : "Inspiration",
      "status" : "ACTIVE",
      "features" : [ ],
      "type" : "CONTENT",
      "contentTypes" : [ ],
      "itemLocales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/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/5ddfc88b46e0fb03956c2359/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2359/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-repositories?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-repositories?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/content-repositories?page=0&size=20"
    },
    "search:findByFeaturesContaining" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2356/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/5ddfc88b46e0fb03956c23ae 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" : "5ddfc88b46e0fb03956c23ae",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c23ad"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c23ad/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c23ad/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/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/5ddfc88b46e0fb03956c23ae/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c23ae/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/5ddfc88b46e0fb03956c2403 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/5ddfc88b46e0fb03956c2403
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3158

{
  "id" : "5ddfc88b46e0fb03956c2403",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2402"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2402/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc88b46e0fb03956c2402/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/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/5ddfc88b46e0fb03956c2403/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88b46e0fb03956c2403/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/5ddfc91146e0fb03956c5484/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/5ddfc91146e0fb03956c5489/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/5ddfc91146e0fb03956c547f/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" : "5ddfc91146e0fb03956c5481",
      "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/5ddfc91146e0fb03956c5481"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/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/5ddfc91146e0fb03956c5481/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91146e0fb03956c5481/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91146e0fb03956c547f/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/5ddfc88c46e0fb03956c24ad/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/5ddfc87e46e0fb03956c20e4/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" : "5ddfc87f46e0fb03956c20e8",
  "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: Thu, 28 Nov 2019 13:15:43 GMT
Location: https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "a963fce3-608c-45f6-9252-672ea035300f",
  "folderId" : "5ddfc87f46e0fb03956c20e8",
  "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-11-28T13:15:43.133Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:43.133Z",
  "deliveryId" : "a963fce3-608c-45f6-9252-672ea035300f",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a963fce3-608c-45f6-9252-672ea035300f"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87e46e0fb03956c20e4"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a963fce3-608c-45f6-9252-672ea035300f",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87f46e0fb03956c20e8"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a963fce3-608c-45f6-9252-672ea035300f{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a963fce3-608c-45f6-9252-672ea035300f/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/b4cf8945-1dd2-47d8-8d79-1a8c979eba14 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: Thu, 28 Nov 2019 13:15:42 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "b4cf8945-1dd2-47d8-8d79-1a8c979eba14",
  "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-11-28T13:15:42.673Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:42.673Z",
  "deliveryId" : "b4cf8945-1dd2-47d8-8d79-1a8c979eba14",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b4cf8945-1dd2-47d8-8d79-1a8c979eba14"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87e46e0fb03956c208b"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b4cf8945-1dd2-47d8-8d79-1a8c979eba14",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b4cf8945-1dd2-47d8-8d79-1a8c979eba14{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4cf8945-1dd2-47d8-8d79-1a8c979eba14/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/8c2311fa-d400-4a20-80f0-83ca9f71ab78 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" : "5ddfc87f46e0fb03956c2143"
}

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: Thu, 28 Nov 2019 13:15:43 GMT
Location: https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "8c2311fa-d400-4a20-80f0-83ca9f71ab78",
  "folderId" : "5ddfc87f46e0fb03956c2143",
  "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-11-28T13:15:43.515Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:43.556Z",
  "deliveryId" : "8c2311fa-d400-4a20-80f0-83ca9f71ab78",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8c2311fa-d400-4a20-80f0-83ca9f71ab78"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c213f"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8c2311fa-d400-4a20-80f0-83ca9f71ab78",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87f46e0fb03956c2143"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8c2311fa-d400-4a20-80f0-83ca9f71ab78{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8c2311fa-d400-4a20-80f0-83ca9f71ab78/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/5ddfc8fe46e0fb03956c514e/content-items?sourceContentItemId=c097a873-6980-45c1-96b5-2265100aad11 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: Thu, 28 Nov 2019 13:17:50 GMT
Location: https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "e22cfbb3-c552-4746-bd62-69a19991066f",
  "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-11-28T13:17:50.745Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:50.745Z",
  "deliveryId" : "e22cfbb3-c552-4746-bd62-69a19991066f",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e22cfbb3-c552-4746-bd62-69a19991066f"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fe46e0fb03956c514e"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e22cfbb3-c552-4746-bd62-69a19991066f",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e22cfbb3-c552-4746-bd62-69a19991066f{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e22cfbb3-c552-4746-bd62-69a19991066f/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/5ddfc8fe46e0fb03956c5156/content-items?sourceContentItemId=cbfcd4ce-3c97-4566-a1f8-c70be78ea1a6 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" : "5ddfc8fe46e0fb03956c515c"
}

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: Thu, 28 Nov 2019 13:17:50 GMT
Location: https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "7fac7c4e-82cb-49be-8312-f9fa8d3f5270",
  "folderId" : "5ddfc8fe46e0fb03956c515c",
  "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-11-28T13:17:50.942Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:50.942Z",
  "deliveryId" : "7fac7c4e-82cb-49be-8312-f9fa8d3f5270",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7fac7c4e-82cb-49be-8312-f9fa8d3f5270"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fe46e0fb03956c5156"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7fac7c4e-82cb-49be-8312-f9fa8d3f5270",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fe46e0fb03956c515c"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7fac7c4e-82cb-49be-8312-f9fa8d3f5270{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7fac7c4e-82cb-49be-8312-f9fa8d3f5270/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/2330243e-75aa-4c7c-a8b4-9d4e50d97640/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" : "2330243e-75aa-4c7c-a8b4-9d4e50d97640",
  "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-11-28T13:17:47.374Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:47.393Z",
  "deliveryId" : "2330243e-75aa-4c7c-a8b4-9d4e50d97640",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2330243e-75aa-4c7c-a8b4-9d4e50d97640"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4ef7"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2330243e-75aa-4c7c-a8b4-9d4e50d97640",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2330243e-75aa-4c7c-a8b4-9d4e50d97640{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2330243e-75aa-4c7c-a8b4-9d4e50d97640/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/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/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" : "b2ace52d-09f9-4c8c-a22f-a73c3cff8b62",
  "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" : "b2ace52d-09f9-4c8c-a22f-a73c3cff8b62",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b2ace52d-09f9-4c8c-a22f-a73c3cff8b62"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4fab"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b2ace52d-09f9-4c8c-a22f-a73c3cff8b62",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b2ace52d-09f9-4c8c-a22f-a73c3cff8b62{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b2ace52d-09f9-4c8c-a22f-a73c3cff8b62/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" : "5ddfc88a46e0fb03956c2254",
  "id" : "b307781c-83d8-4d12-bf38-8cc12be67c18"
}, {
  "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" : "5ddfc88a46e0fb03956c2254",
  "id" : "e26752d5-4bb0-4d8a-8e5d-fb6d6f707802"
} ]

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" : "b307781c-83d8-4d12-bf38-8cc12be67c18",
    "status" : 200,
    "code" : "SUCCESS",
    "level" : "INFO",
    "message" : null
  }, {
    "id" : "e26752d5-4bb0-4d8a-8e5d-fb6d6f707802",
    "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/5ddfc87f46e0fb03956c219a/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" : "95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed",
      "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-11-28T13:15:44.018Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:44.018Z",
      "deliveryId" : "95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95cd50eb-5d5b-46b6-bb4e-f7d54788e8ed/workflow"
        }
      }
    }, {
      "id" : "50006d3c-feab-4c05-a3bd-1c248b7f6b7e",
      "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-11-28T13:15:43.989Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:43.989Z",
      "deliveryId" : "50006d3c-feab-4c05-a3bd-1c248b7f6b7e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=50006d3c-feab-4c05-a3bd-1c248b7f6b7e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=50006d3c-feab-4c05-a3bd-1c248b7f6b7e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=50006d3c-feab-4c05-a3bd-1c248b7f6b7e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/50006d3c-feab-4c05-a3bd-1c248b7f6b7e/workflow"
        }
      }
    }, {
      "id" : "b0a1b4a4-1b32-4bf6-9fab-330d73245425",
      "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-11-28T13:15:43.958Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:43.958Z",
      "deliveryId" : "b0a1b4a4-1b32-4bf6-9fab-330d73245425",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b0a1b4a4-1b32-4bf6-9fab-330d73245425"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b0a1b4a4-1b32-4bf6-9fab-330d73245425",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b0a1b4a4-1b32-4bf6-9fab-330d73245425{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0a1b4a4-1b32-4bf6-9fab-330d73245425/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87f46e0fb03956c219a/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/5ddfc8fb46e0fb03956c4f51/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" : [ {
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "label" : "Banner Ad Homepage",
      "createdBy" : "user",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "deliveryId" : "601a6fc4-8f53-40cc-aa66-0bab42644122",
      "folderId" : null,
      "version" : 1,
      "locale" : "en",
      "status" : "ACTIVE",
      "id" : "601a6fc4-8f53-40cc-aa66-0bab42644122",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=601a6fc4-8f53-40cc-aa66-0bab42644122"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4f51"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=601a6fc4-8f53-40cc-aa66-0bab42644122",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=601a6fc4-8f53-40cc-aa66-0bab42644122{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/601a6fc4-8f53-40cc-aa66-0bab42644122/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4f51/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4f51/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4f51/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fb46e0fb03956c4f51/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/5ddfc88046e0fb03956c21f5/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" : "3766c742-973a-499b-ac4d-dd8ed3842aeb",
      "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-11-28T13:15:44.440Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:44.440Z",
      "deliveryId" : "3766c742-973a-499b-ac4d-dd8ed3842aeb",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3766c742-973a-499b-ac4d-dd8ed3842aeb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3766c742-973a-499b-ac4d-dd8ed3842aeb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3766c742-973a-499b-ac4d-dd8ed3842aeb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3766c742-973a-499b-ac4d-dd8ed3842aeb/workflow"
        }
      }
    }, {
      "id" : "9c3854ee-5f68-4011-8d0e-96e36fbde089",
      "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-11-28T13:15:44.478Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:44.478Z",
      "deliveryId" : "9c3854ee-5f68-4011-8d0e-96e36fbde089",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9c3854ee-5f68-4011-8d0e-96e36fbde089"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9c3854ee-5f68-4011-8d0e-96e36fbde089",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9c3854ee-5f68-4011-8d0e-96e36fbde089{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9c3854ee-5f68-4011-8d0e-96e36fbde089/workflow"
        }
      }
    }, {
      "id" : "3d340824-dac6-4168-8e36-fdfdc20eaf1f",
      "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-11-28T13:15:44.514Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:44.514Z",
      "deliveryId" : "3d340824-dac6-4168-8e36-fdfdc20eaf1f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3d340824-dac6-4168-8e36-fdfdc20eaf1f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3d340824-dac6-4168-8e36-fdfdc20eaf1f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3d340824-dac6-4168-8e36-fdfdc20eaf1f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3d340824-dac6-4168-8e36-fdfdc20eaf1f/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc88046e0fb03956c21f5/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/5ddfc8fd46e0fb03956c5073/content-items?folderId=5ddfc8fd46e0fb03956c5077 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" : "1debad0d-b9ef-4fc2-b244-4c8f3d52d50a",
      "folderId" : "5ddfc8fd46e0fb03956c5077",
      "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-11-28T13:17:49.272Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.272Z",
      "deliveryId" : "1debad0d-b9ef-4fc2-b244-4c8f3d52d50a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1debad0d-b9ef-4fc2-b244-4c8f3d52d50a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5073"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1debad0d-b9ef-4fc2-b244-4c8f3d52d50a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5077"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1debad0d-b9ef-4fc2-b244-4c8f3d52d50a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1debad0d-b9ef-4fc2-b244-4c8f3d52d50a/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5073/content-items?folderId=5ddfc8fd46e0fb03956c5077&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5073/content-items?folderId=5ddfc8fd46e0fb03956c5077&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5073/content-items?folderId=5ddfc8fd46e0fb03956c5077&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5073/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/5ddfc8fc46e0fb03956c5066/content-items?folderId=5ddfc8fc46e0fb03956c506a,5ddfc8fd46e0fb03956c506b 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" : "2bbb2f56-2204-48fe-9612-fd48cd919c6f",
      "folderId" : "5ddfc8fd46e0fb03956c506b",
      "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-11-28T13:17:49.075Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.075Z",
      "deliveryId" : "2bbb2f56-2204-48fe-9612-fd48cd919c6f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2bbb2f56-2204-48fe-9612-fd48cd919c6f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2bbb2f56-2204-48fe-9612-fd48cd919c6f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c506b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2bbb2f56-2204-48fe-9612-fd48cd919c6f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2bbb2f56-2204-48fe-9612-fd48cd919c6f/workflow"
        }
      }
    }, {
      "id" : "819e20b6-d69e-4b3d-8953-9402e0f1842f",
      "folderId" : "5ddfc8fd46e0fb03956c506b",
      "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-11-28T13:17:49.057Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.057Z",
      "deliveryId" : "819e20b6-d69e-4b3d-8953-9402e0f1842f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=819e20b6-d69e-4b3d-8953-9402e0f1842f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=819e20b6-d69e-4b3d-8953-9402e0f1842f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c506b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=819e20b6-d69e-4b3d-8953-9402e0f1842f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/819e20b6-d69e-4b3d-8953-9402e0f1842f/workflow"
        }
      }
    }, {
      "id" : "cdc247d1-6709-4c0a-8f52-ea6d55b274e8",
      "folderId" : "5ddfc8fd46e0fb03956c506b",
      "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-11-28T13:17:49.039Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.039Z",
      "deliveryId" : "cdc247d1-6709-4c0a-8f52-ea6d55b274e8",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=cdc247d1-6709-4c0a-8f52-ea6d55b274e8"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cdc247d1-6709-4c0a-8f52-ea6d55b274e8",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c506b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cdc247d1-6709-4c0a-8f52-ea6d55b274e8{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cdc247d1-6709-4c0a-8f52-ea6d55b274e8/workflow"
        }
      }
    }, {
      "id" : "cd27f5e7-7791-41a4-881d-b3b1979b7619",
      "folderId" : "5ddfc8fc46e0fb03956c506a",
      "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-11-28T13:17:49.021Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.021Z",
      "deliveryId" : "cd27f5e7-7791-41a4-881d-b3b1979b7619",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=cd27f5e7-7791-41a4-881d-b3b1979b7619"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cd27f5e7-7791-41a4-881d-b3b1979b7619",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fc46e0fb03956c506a"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cd27f5e7-7791-41a4-881d-b3b1979b7619{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd27f5e7-7791-41a4-881d-b3b1979b7619/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066/content-items?folderId=5ddfc8fc46e0fb03956c506a,5ddfc8fd46e0fb03956c506b&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066/content-items?folderId=5ddfc8fc46e0fb03956c506a,5ddfc8fd46e0fb03956c506b&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066/content-items?folderId=5ddfc8fc46e0fb03956c506a,5ddfc8fd46e0fb03956c506b&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fc46e0fb03956c5066/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/5ddfc8fd46e0fb03956c5080/content-items?folderId=5ddfc8fd46e0fb03956c5084&folderId=5ddfc8fd46e0fb03956c5085 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" : "bb6feeb3-b859-449a-85e2-c0a2112caaa5",
      "folderId" : "5ddfc8fd46e0fb03956c5085",
      "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-11-28T13:17:49.567Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.567Z",
      "deliveryId" : "bb6feeb3-b859-449a-85e2-c0a2112caaa5",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bb6feeb3-b859-449a-85e2-c0a2112caaa5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bb6feeb3-b859-449a-85e2-c0a2112caaa5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5085"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bb6feeb3-b859-449a-85e2-c0a2112caaa5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb6feeb3-b859-449a-85e2-c0a2112caaa5/workflow"
        }
      }
    }, {
      "id" : "8d582e93-ccbd-4eba-bd85-d75faad2be07",
      "folderId" : "5ddfc8fd46e0fb03956c5085",
      "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-11-28T13:17:49.547Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.547Z",
      "deliveryId" : "8d582e93-ccbd-4eba-bd85-d75faad2be07",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8d582e93-ccbd-4eba-bd85-d75faad2be07"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8d582e93-ccbd-4eba-bd85-d75faad2be07",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5085"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8d582e93-ccbd-4eba-bd85-d75faad2be07{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8d582e93-ccbd-4eba-bd85-d75faad2be07/workflow"
        }
      }
    }, {
      "id" : "efe52b4b-7397-464b-a1fb-ea2b4ecad76f",
      "folderId" : "5ddfc8fd46e0fb03956c5085",
      "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-11-28T13:17:49.526Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.526Z",
      "deliveryId" : "efe52b4b-7397-464b-a1fb-ea2b4ecad76f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=efe52b4b-7397-464b-a1fb-ea2b4ecad76f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=efe52b4b-7397-464b-a1fb-ea2b4ecad76f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5085"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=efe52b4b-7397-464b-a1fb-ea2b4ecad76f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/efe52b4b-7397-464b-a1fb-ea2b4ecad76f/workflow"
        }
      }
    }, {
      "id" : "6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e",
      "folderId" : "5ddfc8fd46e0fb03956c5084",
      "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-11-28T13:17:49.505Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.505Z",
      "deliveryId" : "6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5084"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6aa8e64a-abf7-4b90-87fb-ac5ccf0c6e2e/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080/content-items?folderId=5ddfc8fd46e0fb03956c5084&folderId=5ddfc8fd46e0fb03956c5085&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080/content-items?folderId=5ddfc8fd46e0fb03956c5084&folderId=5ddfc8fd46e0fb03956c5085&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080/content-items?folderId=5ddfc8fd46e0fb03956c5084&folderId=5ddfc8fd46e0fb03956c5085&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c5080/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/5ddfc8fd46e0fb03956c508d/content-items?folderId=!5ddfc8fd46e0fb03956c5091 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" : "944cec1d-df7b-45f5-85f2-0afe2999879d",
      "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-11-28T13:17:49.835Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.835Z",
      "deliveryId" : "944cec1d-df7b-45f5-85f2-0afe2999879d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=944cec1d-df7b-45f5-85f2-0afe2999879d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=944cec1d-df7b-45f5-85f2-0afe2999879d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=944cec1d-df7b-45f5-85f2-0afe2999879d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/944cec1d-df7b-45f5-85f2-0afe2999879d/workflow"
        }
      }
    }, {
      "id" : "375c2bfa-c978-4442-91f3-d095f01be713",
      "folderId" : "5ddfc8fd46e0fb03956c5092",
      "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-11-28T13:17:49.816Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.816Z",
      "deliveryId" : "375c2bfa-c978-4442-91f3-d095f01be713",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=375c2bfa-c978-4442-91f3-d095f01be713"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=375c2bfa-c978-4442-91f3-d095f01be713",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5092"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=375c2bfa-c978-4442-91f3-d095f01be713{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/375c2bfa-c978-4442-91f3-d095f01be713/workflow"
        }
      }
    }, {
      "id" : "fe85061e-72c1-4a6d-9727-c0eeb0cd3653",
      "folderId" : "5ddfc8fd46e0fb03956c5092",
      "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-11-28T13:17:49.797Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.797Z",
      "deliveryId" : "fe85061e-72c1-4a6d-9727-c0eeb0cd3653",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fe85061e-72c1-4a6d-9727-c0eeb0cd3653"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fe85061e-72c1-4a6d-9727-c0eeb0cd3653",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5092"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fe85061e-72c1-4a6d-9727-c0eeb0cd3653{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe85061e-72c1-4a6d-9727-c0eeb0cd3653/workflow"
        }
      }
    }, {
      "id" : "2db2b806-2f71-42ab-91c1-a96582e07402",
      "folderId" : "5ddfc8fd46e0fb03956c5092",
      "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-11-28T13:17:49.779Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:49.779Z",
      "deliveryId" : "2db2b806-2f71-42ab-91c1-a96582e07402",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2db2b806-2f71-42ab-91c1-a96582e07402"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2db2b806-2f71-42ab-91c1-a96582e07402",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc8fd46e0fb03956c5092"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2db2b806-2f71-42ab-91c1-a96582e07402{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2db2b806-2f71-42ab-91c1-a96582e07402/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d/content-items?folderId=!5ddfc8fd46e0fb03956c5091&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d/content-items?folderId=!5ddfc8fd46e0fb03956c5091&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d/content-items?folderId=!5ddfc8fd46e0fb03956c5091&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fd46e0fb03956c508d/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/cad9cf7a-3d91-42da-9317-3fb22796a30a/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-11-28T13:17:47.017Z",
        "historyEventId" : "0642c611-6b21-44db-9137-afc672b46a34"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6e5f3a13-0b4d-4619-8ea9-da595de2a71b",
        "createdDate" : "2019-11-18T13:17:47.025Z",
        "historyEventId" : "ffea5022-2190-4215-a930-e654f9698257"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "830a1e9c-9fff-46a2-b995-79a821a8bd36",
        "createdDate" : "2019-11-17T13:17:47.025Z",
        "historyEventId" : "ebaf03df-a48d-4ba9-b9f3-420d644f8a2b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "16575cfa-cc53-4f48-9239-d5838cd61a94",
        "createdDate" : "2019-11-16T13:17:47.025Z",
        "historyEventId" : "ba241d1f-c93d-4da4-9474-7ae116b489e6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b6d23f04-a185-4bb9-bf09-b6cbca7f900f",
        "createdDate" : "2019-11-15T13:17:47.025Z",
        "historyEventId" : "1ce1fa75-cf3f-49bb-b6de-98fc53429737"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "793af54e-d4f1-4e6c-950e-d063d7f8e15d",
        "createdDate" : "2019-11-14T13:17:47.025Z",
        "historyEventId" : "3d28d5d5-3afa-4c1f-af1d-24695d0193e6"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:47.016Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.982Z",
        "historyEventId" : "580bc09c-9275-4d95-8acf-5510c6c801ff"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c61b820e-9d0f-46a0-b88f-f1a4d59d5ff4",
        "createdDate" : "2019-11-17T13:17:47.025Z",
        "historyEventId" : "9358c67d-4ec9-401d-b796-629dff1fb09a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "64104dd7-600b-4fdf-baab-15e0b3c39f58",
        "createdDate" : "2019-11-16T13:17:47.025Z",
        "historyEventId" : "59a2f2df-fd53-487d-9325-6d93384bd1b6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a1cce58d-b6c3-45a4-9d1f-ed4dce803b35",
        "createdDate" : "2019-11-15T13:17:47.025Z",
        "historyEventId" : "99ef1137-201b-4c13-bd89-2998c2eac2ae"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "02a760c9-7b26-44e7-b5c8-4b41956a84a3",
        "createdDate" : "2019-11-14T13:17:47.025Z",
        "historyEventId" : "09c9c22f-4c66-49a0-93c6-cb91bb106d56"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "13be4947-c81e-4ed5-9546-00772e83d1cd",
        "createdDate" : "2019-11-13T13:17:47.025Z",
        "historyEventId" : "d7031722-7e9b-4e22-b471-a659a22ab4e5"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.980Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.946Z",
        "historyEventId" : "28057d82-9541-42fe-a26c-b599f1dc324b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "751b29f2-ade5-4580-97d3-0d6d044f821c",
        "createdDate" : "2019-11-16T13:17:47.025Z",
        "historyEventId" : "54c019cb-4f74-4cca-9c46-c93aadf7c5c1"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "3826ca8e-c9ea-4751-ab1f-6d36fe75abe9",
        "createdDate" : "2019-11-15T13:17:47.025Z",
        "historyEventId" : "5c6166bf-05bb-412c-9b04-8d45ff39d2f0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "06f8fc3b-eadb-4146-827a-144d4d7ac2c3",
        "createdDate" : "2019-11-14T13:17:47.025Z",
        "historyEventId" : "75ff93a2-9ad9-4412-923b-d0badfae4ff0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "e9a0b901-177d-4ca4-9480-14825b7c5997",
        "createdDate" : "2019-11-13T13:17:47.025Z",
        "historyEventId" : "3aa6f363-e839-4d80-b286-e872021eb202"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "641ea8cc-87f0-4f74-8426-41fa4459b367",
        "createdDate" : "2019-11-12T13:17:47.025Z",
        "historyEventId" : "22d03cc0-fbf1-4fdf-a4d9-eba74ba14815"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.945Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.912Z",
        "historyEventId" : "35144b49-2ef6-4007-aa66-4516d9ed06b1"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "79ac23bd-c7b4-40d2-9153-a825a36796ee",
        "createdDate" : "2019-11-15T13:17:47.025Z",
        "historyEventId" : "5f5d179a-5783-4dcd-b646-1aaa1d24bd19"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1839d3f7-fdb1-4704-831d-d6c9ca386f99",
        "createdDate" : "2019-11-14T13:17:47.025Z",
        "historyEventId" : "407bc4ef-699f-42fe-ad46-6883fbd7b497"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ca904bce-60d0-4fbc-85a8-536739cd73a6",
        "createdDate" : "2019-11-13T13:17:47.025Z",
        "historyEventId" : "3647cea6-ce4a-4411-b581-4a39ffb20482"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "d4e80a70-2d14-44b3-84f7-21e2c3f16174",
        "createdDate" : "2019-11-12T13:17:47.025Z",
        "historyEventId" : "5da8fad9-fd6e-4190-a376-48dbecfb05c8"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "1fdbe8db-422e-4c47-8f48-bb7bcbcb87e6",
        "createdDate" : "2019-11-11T13:17:47.025Z",
        "historyEventId" : "e6b4dece-15a5-4896-b53e-ead104859f53"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.911Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.879Z",
        "historyEventId" : "15dfb6af-275b-4141-bda9-f65bbadf983e"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1bf32cfd-85e8-4c0d-b9f3-2354ad9549da",
        "createdDate" : "2019-11-14T13:17:47.025Z",
        "historyEventId" : "4f12706d-fb44-4b1d-9b51-a4abdd73f634"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5dc8902e-fc1b-40ee-8639-64080e720148",
        "createdDate" : "2019-11-13T13:17:47.025Z",
        "historyEventId" : "3c05cedb-f783-4c31-9a5e-1d0328f862d4"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "b7d34611-0786-4abc-bfbd-0c1e74245578",
        "createdDate" : "2019-11-12T13:17:47.025Z",
        "historyEventId" : "bfec9864-20a2-4706-bc74-669ee5fd2fd1"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "7405d130-6c8b-439f-b859-7aa39e370f51",
        "createdDate" : "2019-11-11T13:17:47.025Z",
        "historyEventId" : "62a491ac-d02b-430e-bfb8-8dac298f7446"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "92961180-8da1-42e6-b8eb-5c370ac81860",
        "createdDate" : "2019-11-10T13:17:47.025Z",
        "historyEventId" : "e2e50868-1a0e-421a-a9ca-305eb496c9aa"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.878Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.845Z",
        "historyEventId" : "164e27ab-2262-411f-8d8e-a8bb7fb0c5f3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "af0b06b8-d0c8-42cc-b1c9-3b67ba650ac1",
        "createdDate" : "2019-11-13T13:17:47.025Z",
        "historyEventId" : "30ce4454-7344-4b0a-97ec-2c92bddb7881"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "60e15586-f404-4ca9-99bf-86366f90a5bc",
        "createdDate" : "2019-11-12T13:17:47.025Z",
        "historyEventId" : "2ebc48be-3368-44fb-b0c2-3aa6a1eae964"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "cec3233d-094b-415d-bbd1-60ad9258d188",
        "createdDate" : "2019-11-11T13:17:47.025Z",
        "historyEventId" : "98a44bd7-a637-4d61-add3-3062bd1a5e7c"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "cba516fa-21ee-4647-ac9e-3b900dc6769b",
        "createdDate" : "2019-11-10T13:17:47.025Z",
        "historyEventId" : "c3129491-1782-401e-b2af-68b1aa30336f"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d1d70f8c-1ff3-4c04-9837-f6c42bc86621",
        "createdDate" : "2019-11-09T13:17:47.025Z",
        "historyEventId" : "41f4a38f-c32a-4a8c-95a4-ab592298364f"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.844Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.812Z",
        "historyEventId" : "1b8599fd-59bc-4a3e-b97b-20730f67174a"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "941a4188-2921-49ee-86d6-454d01848a34",
        "createdDate" : "2019-11-12T13:17:47.025Z",
        "historyEventId" : "95385a75-7a9d-4b2f-a1fa-bcc1aa4075ee"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "a2782c24-1dc6-4d49-ae66-d233269d3cf7",
        "createdDate" : "2019-11-11T13:17:47.025Z",
        "historyEventId" : "5d3d1040-7c7e-4b85-9741-afcc5b5443ea"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "36aee852-fa36-4275-b4ff-ea23e36c365f",
        "createdDate" : "2019-11-10T13:17:47.025Z",
        "historyEventId" : "94ddc2c0-59d0-45ba-8c84-ecee0d83d9e0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2442bd2f-b901-4590-a3da-e7db332fa739",
        "createdDate" : "2019-11-09T13:17:47.025Z",
        "historyEventId" : "e2f66ba3-7e78-4c01-97c1-1c2772c83ea2"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.811Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.779Z",
        "historyEventId" : "9b7e0135-e51c-4af1-acb0-6e36cb44cdbc"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "d9cf45ef-c26b-4408-8e8e-cbcd15f52f16",
        "createdDate" : "2019-11-11T13:17:47.025Z",
        "historyEventId" : "44bb13c8-0daf-45e3-8fb3-0c4ef6d19caa"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "2f06db79-6134-497b-844a-bcb17e6b56be",
        "createdDate" : "2019-11-10T13:17:47.025Z",
        "historyEventId" : "6e1c14c7-7794-4f7c-a281-6141120ebaa7"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "dbf9ba67-07d6-4db6-b0d0-43311f2bef9b",
        "createdDate" : "2019-11-09T13:17:47.025Z",
        "historyEventId" : "ead505ba-68c7-47c3-81c1-67ed546fe97b"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.778Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.744Z",
        "historyEventId" : "61e31a44-2685-447a-afdf-3aaa88ab9d73"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "e308e308-6705-488f-946f-48981dc97a40",
        "createdDate" : "2019-11-10T13:17:47.025Z",
        "historyEventId" : "4b7fe35c-1b04-47bf-a8c1-5c62598c3888"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5c1888b0-474e-4252-b72c-97710012930d",
        "createdDate" : "2019-11-09T13:17:47.025Z",
        "historyEventId" : "e4c728c4-eba5-4e19-97ad-491017804521"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.743Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:17:46.710Z",
        "historyEventId" : "056f5d54-dcb7-4b2a-8cd5-596a3aced7d6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "fe4e3540-7a8d-4166-8ec9-5625b26653d8",
        "createdDate" : "2019-11-09T13:17:47.025Z",
        "historyEventId" : "286dbd2c-bc35-4b10-a86a-d00f9d68cea9"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:46.709Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cad9cf7a-3d91-42da-9317-3fb22796a30a/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/4ac89feb-62aa-4f07-8e0a-6cee3c89648b/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" : "280212fd-02b0-433d-94a6-87e65fe3a954",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-28T13:17:45.937Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "48315454-6436-4e90-adfb-cf416f8c4fa9",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-24T13:17:45.945Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "1a966c89-7902-4fe7-bbbf-4cc20734b161",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-23T13:17:45.945Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "f5dbe4a7-41df-4eef-82a4-d2293977b23d",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-22T13:17:45.945Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "46658558-48b8-4095-a21a-5cf2b28b8ad2",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-21T13:17:45.945Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "fea06d7c-903c-4f2e-8217-4e9efd2efbf3",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-20T13:17:45.945Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "210c77c6-6906-434a-b371-6952cbe13055",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-19T13:17:45.945Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "dea42777-4b55-4550-ac7f-7661ef873fd0",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-18T13:17:45.945Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "32799d72-4b9f-4fd0-ae27-7811aea2c56b",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-17T13:17:45.945Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "ada101d1-3eff-4265-8b0a-ccbaf3c7f4e7",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-16T13:17:45.945Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0517af56-e13d-4343-b193-fbdaf8eaa146",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-15T13:17:45.945Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "680d734a-103a-466c-b8be-4f118b1dee69",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-14T13:17:45.945Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "166fb1f8-c7a7-409e-a6d1-0295dc7f25cd",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-13T13:17:45.945Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "521e059c-3e4b-4730-95c7-0547c6bf729a",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-12T13:17:45.945Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "de0197e5-f4e1-4697-acdf-eb6a3d32a481",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-11T13:17:45.945Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "5b938b30-4075-49fb-9c09-feb166978236",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-10T13:17:45.945Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "d403bc72-2920-4df0-b2a1-d68c7857ff7c",
      "contentItemId" : "4ac89feb-62aa-4f07-8e0a-6cee3c89648b",
      "version" : 1,
      "createdDate" : "2019-11-09T13:17:45.945Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4ac89feb-62aa-4f07-8e0a-6cee3c89648b/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4ac89feb-62aa-4f07-8e0a-6cee3c89648b/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4ac89feb-62aa-4f07-8e0a-6cee3c89648b/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/8686cda2-2e50-4e80-8e11-bc9a71f888af/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" : "8686cda2-2e50-4e80-8e11-bc9a71f888af",
      "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-11-28T13:17:46.326Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:46.363Z",
      "deliveryId" : "8686cda2-2e50-4e80-8e11-bc9a71f888af",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fa46e0fb03956c4e3b"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8686cda2-2e50-4e80-8e11-bc9a71f888af"
        }
      }
    }, {
      "id" : "8686cda2-2e50-4e80-8e11-bc9a71f888af",
      "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-11-28T13:17:46.326Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:46.363Z",
      "deliveryId" : "8686cda2-2e50-4e80-8e11-bc9a71f888af",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8fa46e0fb03956c4e3b"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8686cda2-2e50-4e80-8e11-bc9a71f888af"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8686cda2-2e50-4e80-8e11-bc9a71f888af/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=7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3 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" : "7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3",
      "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" : "e9298dc9-a8ac-4214-b98a-9ab2bd4018e4"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:15:40.616Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:40.616Z",
      "deliveryId" : "7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87c46e0fb03956c1f24"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3/workflow"
        }
      }
    }, {
      "id" : "e9298dc9-a8ac-4214-b98a-9ab2bd4018e4",
      "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" : "3f56997c-61af-483a-8e1a-6e712f19af8a"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:15:40.573Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:40.573Z",
      "deliveryId" : "e9298dc9-a8ac-4214-b98a-9ab2bd4018e4",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e9298dc9-a8ac-4214-b98a-9ab2bd4018e4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87c46e0fb03956c1f24"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e9298dc9-a8ac-4214-b98a-9ab2bd4018e4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e9298dc9-a8ac-4214-b98a-9ab2bd4018e4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e9298dc9-a8ac-4214-b98a-9ab2bd4018e4/workflow"
        }
      }
    }, {
      "id" : "3f56997c-61af-483a-8e1a-6e712f19af8a",
      "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-11-28T13:15:40.526Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:15:40.526Z",
      "deliveryId" : "3f56997c-61af-483a-8e1a-6e712f19af8a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3f56997c-61af-483a-8e1a-6e712f19af8a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87c46e0fb03956c1f24"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3f56997c-61af-483a-8e1a-6e712f19af8a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3f56997c-61af-483a-8e1a-6e712f19af8a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3f56997c-61af-483a-8e1a-6e712f19af8a/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7e467f6a-dc10-43ae-b83e-8b7f5ea97cd3{?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/e4999477-3569-431b-91b4-0f771f2ef435/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" : "e4999477-3569-431b-91b4-0f771f2ef435",
  "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-11-28T13:15:42.201Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:42.201Z",
  "deliveryId" : "e4999477-3569-431b-91b4-0f771f2ef435",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e4999477-3569-431b-91b4-0f771f2ef435/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87d46e0fb03956c2031"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e4999477-3569-431b-91b4-0f771f2ef435"
    }
  }
}

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/d81f7e17-3ace-4a47-b582-c935fb6af17e/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" : "d81f7e17-3ace-4a47-b582-c935fb6af17e",
  "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-11-28T13:15:41.648Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:41.770Z",
  "deliveryId" : "d81f7e17-3ace-4a47-b582-c935fb6af17e",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d81f7e17-3ace-4a47-b582-c935fb6af17e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87d46e0fb03956c1fd5"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d81f7e17-3ace-4a47-b582-c935fb6af17e"
    }
  }
}

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/58a6d192-763a-44dc-930e-8e213de55a6a/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" : "58a6d192-763a-44dc-930e-8e213de55a6a",
  "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-11-28T13:15:39.693Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:15:39.941Z",
  "deliveryId" : "58a6d192-763a-44dc-930e-8e213de55a6a",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58a6d192-763a-44dc-930e-8e213de55a6a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87b46e0fb03956c1ec7"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=58a6d192-763a-44dc-930e-8e213de55a6a"
    }
  }
}

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/f43287dd-e19e-48ac-a1fa-27057a93e3f1/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: Thu, 28 Nov 2019 13:17:51 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "f43287dd-e19e-48ac-a1fa-27057a93e3f1",
  "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-11-28T13:17:51.759Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:51.836Z",
  "deliveryId" : "f43287dd-e19e-48ac-a1fa-27057a93e3f1",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f43287dd-e19e-48ac-a1fa-27057a93e3f1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8ff46e0fb03956c520c"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f43287dd-e19e-48ac-a1fa-27057a93e3f1",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f43287dd-e19e-48ac-a1fa-27057a93e3f1{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f43287dd-e19e-48ac-a1fa-27057a93e3f1/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/5ddfc90646e0fb03956c532c/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" : "995b49d2-6fa1-4aee-8df3-b57c80a6248c",
      "contentRepositoryId" : "5ddfc90646e0fb03956c532d",
      "folderId" : null,
      "deliveryId" : "995b49d2-6fa1-4aee-8df3-b57c80a6248c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:59.564Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:59.564Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90646e0fb03956c532d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=995b49d2-6fa1-4aee-8df3-b57c80a6248c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=995b49d2-6fa1-4aee-8df3-b57c80a6248c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/995b49d2-6fa1-4aee-8df3-b57c80a6248c/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90646e0fb03956c532c/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90646e0fb03956c532c/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90646e0fb03956c532c/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/5ddfc90b46e0fb03956c5386/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" : "d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "9c4c3ac7-818d-4f7b-96fa-ff5cfd49d62b",
      "createdBy" : "user",
      "createdDate" : "2019-10-30T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-10-30T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d84b5cbd-dd4c-4d1b-b50e-cf7c62e026bd/workflow"
        }
      }
    }, {
      "id" : "31f8dfad-d50f-4ea8-8354-fda2f1dd38b4",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "31f8dfad-d50f-4ea8-8354-fda2f1dd38b4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "62bcf20e-006e-4f13-a881-245922848d85",
      "createdBy" : "user",
      "createdDate" : "2019-10-31T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-10-31T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=31f8dfad-d50f-4ea8-8354-fda2f1dd38b4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=31f8dfad-d50f-4ea8-8354-fda2f1dd38b4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31f8dfad-d50f-4ea8-8354-fda2f1dd38b4/workflow"
        }
      }
    }, {
      "id" : "e4e07559-4c42-4253-8363-80ff715873a9",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "e4e07559-4c42-4253-8363-80ff715873a9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "cbc1cbe4-08c7-46e8-bfe5-0a2c4bc1afd6",
      "createdBy" : "user",
      "createdDate" : "2019-11-01T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-01T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e4e07559-4c42-4253-8363-80ff715873a9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e4e07559-4c42-4253-8363-80ff715873a9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e4e07559-4c42-4253-8363-80ff715873a9/workflow"
        }
      }
    }, {
      "id" : "9aec9141-bb4c-43c5-84c6-27c16a56a6b3",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "9aec9141-bb4c-43c5-84c6-27c16a56a6b3",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7955e98b-5925-4ac0-95ac-82e59907b505",
      "createdBy" : "user",
      "createdDate" : "2019-11-02T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-02T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9aec9141-bb4c-43c5-84c6-27c16a56a6b3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9aec9141-bb4c-43c5-84c6-27c16a56a6b3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aec9141-bb4c-43c5-84c6-27c16a56a6b3/workflow"
        }
      }
    }, {
      "id" : "0fced957-12fa-42f6-b12e-5b8eb3f86476",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "0fced957-12fa-42f6-b12e-5b8eb3f86476",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "6eaafd0c-0a15-420d-a0bd-d50216f8cec9",
      "createdBy" : "user",
      "createdDate" : "2019-11-03T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-03T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0fced957-12fa-42f6-b12e-5b8eb3f86476",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0fced957-12fa-42f6-b12e-5b8eb3f86476{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fced957-12fa-42f6-b12e-5b8eb3f86476/workflow"
        }
      }
    }, {
      "id" : "88389c39-f8e6-411d-a5cd-a7e91bd05564",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "88389c39-f8e6-411d-a5cd-a7e91bd05564",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7421070f-ebcc-48da-a3e0-a89c3fcf27db",
      "createdBy" : "user",
      "createdDate" : "2019-11-04T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-04T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=88389c39-f8e6-411d-a5cd-a7e91bd05564",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=88389c39-f8e6-411d-a5cd-a7e91bd05564{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88389c39-f8e6-411d-a5cd-a7e91bd05564/workflow"
        }
      }
    }, {
      "id" : "5dc5daa1-8af5-406c-aa48-abfec3a80642",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "5dc5daa1-8af5-406c-aa48-abfec3a80642",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "559ae9a0-1795-4f03-bc39-35ad2dcb0514",
      "createdBy" : "user",
      "createdDate" : "2019-11-05T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-05T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5dc5daa1-8af5-406c-aa48-abfec3a80642",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5dc5daa1-8af5-406c-aa48-abfec3a80642{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5dc5daa1-8af5-406c-aa48-abfec3a80642/workflow"
        }
      }
    }, {
      "id" : "79e5d0d4-d887-499d-97c6-dbffe72e77f7",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "79e5d0d4-d887-499d-97c6-dbffe72e77f7",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "2778c333-f712-4e8b-b573-9508653d0784",
      "createdBy" : "user",
      "createdDate" : "2019-11-06T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-06T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=79e5d0d4-d887-499d-97c6-dbffe72e77f7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=79e5d0d4-d887-499d-97c6-dbffe72e77f7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79e5d0d4-d887-499d-97c6-dbffe72e77f7/workflow"
        }
      }
    }, {
      "id" : "a2146cbb-80f8-4ecd-99d3-7c108066f705",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "a2146cbb-80f8-4ecd-99d3-7c108066f705",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1e4b7a35-c851-4828-908e-92f82761589d",
      "createdBy" : "user",
      "createdDate" : "2019-11-07T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-07T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a2146cbb-80f8-4ecd-99d3-7c108066f705",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a2146cbb-80f8-4ecd-99d3-7c108066f705{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2146cbb-80f8-4ecd-99d3-7c108066f705/workflow"
        }
      }
    }, {
      "id" : "4f50638e-325c-48b1-80e9-2601388ba093",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "4f50638e-325c-48b1-80e9-2601388ba093",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1a15cfe7-ea58-4880-8ff2-998f8dab660c",
      "createdBy" : "user",
      "createdDate" : "2019-11-08T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-08T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4f50638e-325c-48b1-80e9-2601388ba093",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4f50638e-325c-48b1-80e9-2601388ba093{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4f50638e-325c-48b1-80e9-2601388ba093/workflow"
        }
      }
    }, {
      "id" : "e00f66dc-f336-45dd-b706-9a26803784ff",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "e00f66dc-f336-45dd-b706-9a26803784ff",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "53a6cb01-d1ab-4241-8dc6-3230a96b6005",
      "createdBy" : "user",
      "createdDate" : "2019-11-09T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-09T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e00f66dc-f336-45dd-b706-9a26803784ff",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e00f66dc-f336-45dd-b706-9a26803784ff{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e00f66dc-f336-45dd-b706-9a26803784ff/workflow"
        }
      }
    }, {
      "id" : "519d7824-779b-4989-8428-a605a5b2c89e",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "519d7824-779b-4989-8428-a605a5b2c89e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "63391ed3-2c68-4506-a448-891e76c7d1ae",
      "createdBy" : "user",
      "createdDate" : "2019-11-10T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-10T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=519d7824-779b-4989-8428-a605a5b2c89e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=519d7824-779b-4989-8428-a605a5b2c89e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/519d7824-779b-4989-8428-a605a5b2c89e/workflow"
        }
      }
    }, {
      "id" : "4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "52d4af6f-d893-4ca3-9255-9ae0cf4443c2",
      "createdBy" : "user",
      "createdDate" : "2019-11-11T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-11T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4d8b1c86-7764-41c8-9d13-3e2ac89ce2d9/workflow"
        }
      }
    }, {
      "id" : "a7d81b1a-9887-4432-ad1f-eb4624cf0056",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "a7d81b1a-9887-4432-ad1f-eb4624cf0056",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "fd398fd8-b467-4720-8341-e7e0740edb6e",
      "createdBy" : "user",
      "createdDate" : "2019-11-12T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-12T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a7d81b1a-9887-4432-ad1f-eb4624cf0056",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a7d81b1a-9887-4432-ad1f-eb4624cf0056{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a7d81b1a-9887-4432-ad1f-eb4624cf0056/workflow"
        }
      }
    }, {
      "id" : "95996a78-a719-4ffd-9f6a-f3ca51d29cfa",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "95996a78-a719-4ffd-9f6a-f3ca51d29cfa",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "f32d587a-fd1b-42af-9285-361719456f74",
      "createdBy" : "user",
      "createdDate" : "2019-11-13T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-13T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=95996a78-a719-4ffd-9f6a-f3ca51d29cfa",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=95996a78-a719-4ffd-9f6a-f3ca51d29cfa{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95996a78-a719-4ffd-9f6a-f3ca51d29cfa/workflow"
        }
      }
    }, {
      "id" : "fb59ac9c-a7ca-4986-8698-e791b6867b57",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "fb59ac9c-a7ca-4986-8698-e791b6867b57",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "c46534fc-0031-47b5-a1f8-0646353d3449",
      "createdBy" : "user",
      "createdDate" : "2019-11-14T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-14T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fb59ac9c-a7ca-4986-8698-e791b6867b57",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fb59ac9c-a7ca-4986-8698-e791b6867b57{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fb59ac9c-a7ca-4986-8698-e791b6867b57/workflow"
        }
      }
    }, {
      "id" : "3cddda66-495f-4139-8e1d-0421722aabfc",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "3cddda66-495f-4139-8e1d-0421722aabfc",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "829afe0d-f698-4fda-b4ff-82983fd569d9",
      "createdBy" : "user",
      "createdDate" : "2019-11-15T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-15T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3cddda66-495f-4139-8e1d-0421722aabfc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3cddda66-495f-4139-8e1d-0421722aabfc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3cddda66-495f-4139-8e1d-0421722aabfc/workflow"
        }
      }
    }, {
      "id" : "bd02c024-544e-433e-99cd-9984a2501db4",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "bd02c024-544e-433e-99cd-9984a2501db4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "583fac1b-54c2-4694-a105-5e026190f90f",
      "createdBy" : "user",
      "createdDate" : "2019-11-16T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-16T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bd02c024-544e-433e-99cd-9984a2501db4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bd02c024-544e-433e-99cd-9984a2501db4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bd02c024-544e-433e-99cd-9984a2501db4/workflow"
        }
      }
    }, {
      "id" : "35ed5cad-ebe6-40a9-983b-83cb8acf814e",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "35ed5cad-ebe6-40a9-983b-83cb8acf814e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "69e62357-1c81-4dec-8e84-1a9ac690f5e8",
      "createdBy" : "user",
      "createdDate" : "2019-11-17T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-17T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=35ed5cad-ebe6-40a9-983b-83cb8acf814e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=35ed5cad-ebe6-40a9-983b-83cb8acf814e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/35ed5cad-ebe6-40a9-983b-83cb8acf814e/workflow"
        }
      }
    }, {
      "id" : "1f9e08a5-ada1-4673-8407-dd08e417c7d5",
      "contentRepositoryId" : "5ddfc90b46e0fb03956c538c",
      "folderId" : null,
      "deliveryId" : "1f9e08a5-ada1-4673-8407-dd08e417c7d5",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "69683480-9903-4e7e-863f-91efcd59e612",
      "createdBy" : "user",
      "createdDate" : "2019-11-18T13:18:03.238Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-18T13:18:03.238Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90b46e0fb03956c538c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1f9e08a5-ada1-4673-8407-dd08e417c7d5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1f9e08a5-ada1-4673-8407-dd08e417c7d5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f9e08a5-ada1-4673-8407-dd08e417c7d5/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90b46e0fb03956c5386/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90b46e0fb03956c5386/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90b46e0fb03956c5386/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc90b46e0fb03956c5386/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/783b19a6-e01b-435b-a816-eb84aca120c0/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/5ddfc90046e0fb03956c52d8

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/0356249c-76c3-4b90-990f-491f4396afb2/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" : "0356249c-76c3-4b90-990f-491f4396afb2",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5ddfc8fd46e0fb03956c50ec",
    "eventStart" : "2019-11-28T13:16:29.189Z",
    "eventEnd" : "2019-12-28T13:16:29.189Z",
    "editionTitle" : "Test",
    "editionId" : "5ddfc8fd46e0fb03956c50ed",
    "editionStart" : "2019-11-28T13:16:29.189Z",
    "editionEnd" : "2019-12-28T13:16:29.189Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5ddfc8fe46e0fb03956c50f2",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2019-11-28T13:17:50.361Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-11-28T13:17:50.329Z",
    "snapshotId" : "5ddfc8fe46e0fb03956c50f8",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5ddfc8fd46e0fb03956c50ed/slots/5ddfc8fe46e0fb03956c50f2"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5ddfc8fd46e0fb03956c50ed/slots/5ddfc8fe46e0fb03956c50f2/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0356249c-76c3-4b90-990f-491f4396afb2/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/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

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

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" : "d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e",
  "workflow" : {
    "state" : "5ddfc8f746e0fb03956c4be2"
  },
  "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-11-28T13:17:43.926Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:43.979Z",
  "deliveryId" : "d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8f746e0fb03956c4be0"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d3aa10e5-d2a0-4bc4-a0d6-9911c6806b7e/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/5ddfc8b646e0fb03956c31b9/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/5ddfc8b646e0fb03956c31ba
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1256

{
  "id" : "5ddfc8b646e0fb03956c31ba",
  "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/5ddfc8b646e0fb03956c31ba"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/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/5ddfc8b646e0fb03956c31ba 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" : "5ddfc8b646e0fb03956c31ba",
  "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/5ddfc8b646e0fb03956c31ba"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/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/5ddfc8b646e0fb03956c31ba 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" : "5ddfc8b646e0fb03956c31ba",
  "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/5ddfc8b646e0fb03956c31ba"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5ddfc8b646e0fb03956c31b9/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" : "5ddfc8b646e0fb03956c31ba",
      "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/5ddfc8b646e0fb03956c31ba"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9/events?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9/events?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9/events?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c31b9/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/5ddfc8b646e0fb03956c3165 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 133

{
  "name" : "shoes",
  "start" : "2019-11-28T14:16:38.450Z",
  "end" : "2019-11-28T17:16:38.450Z",
  "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/5ddfc8b646e0fb03956c3165
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1239

{
  "id" : "5ddfc8b646e0fb03956c3165",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-11-28T14:16:38.450Z",
  "end" : "2019-11-28T17:16:38.450Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c3164"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3165/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/5ddfc8b646e0fb03956c3210 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=5ddfc8ad46e0fb03956c29ef&rangeEnd=2019-12-01T13:16:29.324Z&rangeStart=2019-11-25T13:16:29.324Z&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" : "5ddfc8ad46e0fb03956c29f7",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-11-22T13:16:29.324Z",
      "end" : "2019-11-25T13:16:29.324Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29ef"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f7/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8ad46e0fb03956c29f5",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-11-22T13:16:29.324Z",
      "end" : "2019-11-26T13:16:29.324Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29ef"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f5/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8ad46e0fb03956c29f3",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-11-28T13:16:29.324Z",
      "end" : "2019-11-30T13:16:29.324Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29ef"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f3/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8ad46e0fb03956c29f4",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-11-30T13:16:29.324Z",
      "end" : "2019-12-04T13:16:29.324Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29ef"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f4/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8ad46e0fb03956c29f6",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-12-01T13:16:29.324Z",
      "end" : "2019-12-04T13:16:29.324Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29ef"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ad46e0fb03956c29f6/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8ad46e0fb03956c29ef&rangeStart=2019-11-25T13:16:29.324Z&rangeEnd=2019-12-01T13:16:29.324Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8ad46e0fb03956c29ef&rangeStart=2019-11-25T13:16:29.324Z&rangeEnd=2019-12-01T13:16:29.324Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8ad46e0fb03956c29ef&rangeStart=2019-11-25T13:16:29.324Z&rangeEnd=2019-12-01T13:16:29.324Z&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=5ddfc8b546e0fb03956c30f5&rangeEnd=2019-12-01T13:16:37.550Z&rangeStart=2019-11-25T13:16:37.550Z&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" : "5ddfc8b546e0fb03956c30f6",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-11-29T13:16:37.550Z",
      "end" : "2019-11-30T13:16:37.550Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5ddfc8b546e0fb03956c30f7",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-11-29T13:16:37.550Z",
        "end" : "2019-11-30T13:16:37.550Z",
        "eventId" : "5ddfc8b546e0fb03956c30f6",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:37.721Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:37.721Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:37.721Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b546e0fb03956c30f5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30f6/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30f5&rangeStart=2019-11-25T13:16:37.550Z&rangeEnd=2019-12-01T13:16:37.550Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30f5&rangeStart=2019-11-25T13:16:37.550Z&rangeEnd=2019-12-01T13:16:37.550Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30f5&rangeStart=2019-11-25T13:16:37.550Z&rangeEnd=2019-12-01T13:16:37.550Z&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=5ddfc8b546e0fb03956c30fe&rangeStart=2019-11-28T13:16:37.923Z&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" : "5ddfc8b646e0fb03956c3103",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-11-26T13:16:37.923Z",
      "end" : "2019-11-30T13:16:37.923Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b546e0fb03956c30fe"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3103/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8b646e0fb03956c3102",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-11-28T13:16:37.923Z",
      "end" : "2019-11-30T13:16:37.923Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b546e0fb03956c30fe"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c3102/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8b546e0fb03956c3101",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-11-29T13:16:37.923Z",
      "end" : "2019-11-30T13:16:37.923Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b546e0fb03956c30fe"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c3101/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30fe&rangeStart=2019-11-28T13:16:37.923Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30fe&rangeStart=2019-11-28T13:16:37.923Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b546e0fb03956c30fe&rangeStart=2019-11-28T13:16:37.923Z&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=5ddfc8b646e0fb03956c3107&rangeEnd=2019-11-27T23: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" : "5ddfc8b646e0fb03956c310b",
      "name" : "Yesterday",
      "comment" : "This is an event.",
      "start" : "2019-11-27T00:00:00.000Z",
      "end" : "2019-11-27T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c3107"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-11-27T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-11-27T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-11-27T23: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=5ddfc8b646e0fb03956c3107&rangeEnd=2019-11-28T23:59:59.999Z&rangeStart=2019-11-28T00: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" : "5ddfc8b646e0fb03956c310f",
      "name" : "Yesterday to Today",
      "comment" : "This is an event.",
      "start" : "2019-11-27T00:00:00.000Z",
      "end" : "2019-11-28T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c3107"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310f/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-28T00:00:00.000Z&rangeEnd=2019-11-28T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-28T00:00:00.000Z&rangeEnd=2019-11-28T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-28T00:00:00.000Z&rangeEnd=2019-11-28T23:59:59.999Z&bounded=false&page=1&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-28T00:00:00.000Z&rangeEnd=2019-11-28T23: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=5ddfc8b646e0fb03956c3107&rangeEnd=2019-11-29T23:59:59.999Z&rangeStart=2019-11-29T00: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" : "5ddfc8b646e0fb03956c310d",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-11-29T00:00:00.000Z",
      "end" : "2019-11-29T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b646e0fb03956c3107"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c310d/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-29T00:00:00.000Z&rangeEnd=2019-11-29T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-29T00:00:00.000Z&rangeEnd=2019-11-29T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5ddfc8b646e0fb03956c3107&rangeStart=2019-11-29T00:00:00.000Z&rangeEnd=2019-11-29T23: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=5ddfc8b546e0fb03956c30e2&rangeEnd=2019-12-01T13:16:37.176Z&rangeStart=2019-11-25T13:16:37.176Z&bounded=0&slots=49f78276-1b19-41f7-8135-fa409332d059&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" : "5ddfc8b546e0fb03956c30e6",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-11-28T13:16:37.176Z",
      "end" : "2019-11-30T13:16:37.176Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8b546e0fb03956c30e2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b546e0fb03956c30e6/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8b546e0fb03956c30e2&rangeStart=2019-11-25T13:16:37.176Z&rangeEnd=2019-12-01T13:16:37.176Z&bounded=false&slots=49f78276-1b19-41f7-8135-fa409332d059&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8b546e0fb03956c30e2&rangeStart=2019-11-25T13:16:37.176Z&rangeEnd=2019-12-01T13:16:37.176Z&bounded=false&slots=49f78276-1b19-41f7-8135-fa409332d059&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8b546e0fb03956c30e2&rangeStart=2019-11-25T13:16:37.176Z&rangeEnd=2019-12-01T13:16:37.176Z&bounded=false&slots=49f78276-1b19-41f7-8135-fa409332d059&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=5ddfc8ad46e0fb03956c29fb&rangeEnd=2019-12-01T13:16:29.909Z&rangeStart=2019-11-25T13:16:29.909Z&bounded=0&projection=withEditions&slots=50f656db-498f-4842-abc0-be61852721ee&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" : "5ddfc8ae46e0fb03956c2a01",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-11-28T13:16:29.909Z",
      "end" : "2019-11-30T13:16:29.909Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5ddfc8ae46e0fb03956c2a02",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.120Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.124Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.211Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a04",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.235Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.235Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.267Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a07",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.284Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.284Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.313Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a0b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.327Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.328Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.360Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a10",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.373Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.374Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.404Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a16",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.419Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.420Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.453Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a1d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.469Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.469Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.502Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a25",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.518Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.519Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.557Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a2e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.576Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.577Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.623Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a38",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.641Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.642Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.691Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a43",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.710Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.711Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.765Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a4f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.784Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.785Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.837Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a5c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.855Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.856Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.904Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a6a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.924Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.925Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:30.978Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8ae46e0fb03956c2a79",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:30.996Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:30.997Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.055Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2a89",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.075Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.076Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.138Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2a9a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.159Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.160Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.221Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2aac",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.241Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.242Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.308Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2abf",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.330Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.331Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.399Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2ad3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.417Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.418Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.489Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2ae8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.508Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.509Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.574Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2afe",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.593Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.593Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.654Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2b15",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.672Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.672Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.725Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2b2d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.739Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.739Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.789Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2b46",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.803Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.804Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.860Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2b60",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.878Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.878Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:31.950Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8af46e0fb03956c2b7b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:31.964Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:31.965Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.029Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2b97",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.048Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.049Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.127Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2bb4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.146Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.147Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.210Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2bd2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.224Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.224Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.309Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2bf1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.329Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.330Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.411Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2c11",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.426Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.426Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.502Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2c32",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.517Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.518Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.580Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2c54",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.594Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.595Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.651Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2c77",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.666Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.667Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.731Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2c9b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.744Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.745Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.809Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2cc0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.823Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.824Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.886Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2ce6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.900Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.900Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:32.963Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b046e0fb03956c2d0d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:32.978Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:32.978Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.044Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2d35",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.058Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.059Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.125Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2d5e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.138Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.139Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.208Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2d88",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.228Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.229Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.302Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2db3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.321Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.322Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.430Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2ddf",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.445Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.445Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.519Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2e0c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.533Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.534Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.606Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2e3a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.619Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.620Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.690Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2e69",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.704Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.704Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.777Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2e99",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.790Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.791Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.863Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2eca",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.876Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.877Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:33.949Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5ddfc8b146e0fb03956c2efc",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-11-28T13:16:29.909Z",
        "end" : "2019-11-30T13:16:29.909Z",
        "eventId" : "5ddfc8ae46e0fb03956c2a01",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-11-28T13:16:33.964Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-11-28T13:16:33.964Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-11-28T13:16:34.037Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ad46e0fb03956c29fb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8ae46e0fb03956c2a01/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8ad46e0fb03956c29fb&rangeStart=2019-11-25T13:16:29.909Z&rangeEnd=2019-12-01T13:16:29.909Z&bounded=false&slots=50f656db-498f-4842-abc0-be61852721ee&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8ad46e0fb03956c29fb&rangeStart=2019-11-25T13:16:29.909Z&rangeEnd=2019-12-01T13:16:29.909Z&bounded=false&slots=50f656db-498f-4842-abc0-be61852721ee&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5ddfc8ad46e0fb03956c29fb&rangeStart=2019-11-25T13:16:29.909Z&rangeEnd=2019-12-01T13:16:29.909Z&bounded=false&slots=50f656db-498f-4842-abc0-be61852721ee&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/5ddfc8b646e0fb03956c31ba/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: Thu, 28 Nov 2019 13:16:38 GMT
Location: https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

{
  "id" : "5ddfc8b646e0fb03956c31bb",
  "name" : "January Sale",
  "comment" : "This is an example edition.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "eventId" : "5ddfc8b646e0fb03956c31ba",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-11-28T13:16:38.706Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:16:38.707Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:16:38.707Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/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/5ddfc8f646e0fb03956c4ac8/editions?sourceEditionId=5ddfc8f746e0fb03956c4ad1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 171

{
  "name" : "Test",
  "start" : "2019-11-28T13:16:29.189Z",
  "end" : "2019-12-28T13:16:29.189Z",
  "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: Thu, 28 Nov 2019 13:17:43 GMT
Location: https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2619

{
  "id" : "5ddfc8f746e0fb03956c4ad8",
  "name" : "Test",
  "comment" : "This is an example edition.",
  "start" : "2019-11-28T13:16:29.189Z",
  "end" : "2019-12-28T13:16:29.189Z",
  "eventId" : "5ddfc8f646e0fb03956c4ac8",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 197,
  "versionConflicts" : {
    "limitExceeded" : false,
    "conflicts" : 0
  },
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-11-28T13:17:43.288Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:43.289Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:43.289Z",
  "stagedDate" : null,
  "slotCollisions" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8f646e0fb03956c4ac8"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8f746e0fb03956c4ad8/slot-collisions"
    }
  }
}

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5ddfc8b646e0fb03956c31ba/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" : "5ddfc8b646e0fb03956c31bb",
      "name" : "January Sale",
      "comment" : "This is an example edition.",
      "start" : "2017-01-01T00:00:00.000Z",
      "end" : "2017-01-01T23:59:59.000Z",
      "eventId" : "5ddfc8b646e0fb03956c31ba",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-11-28T13:16:38.706Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:16:38.707Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:16:38.707Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/editions?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba/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/5ddfc8b646e0fb03956c31bb 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: Thu, 28 Nov 2019 13:16:38 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

{
  "id" : "5ddfc8b646e0fb03956c31bb",
  "name" : "January Sale",
  "comment" : "This is an example edition.",
  "start" : "2017-01-01T00:00:00.000Z",
  "end" : "2017-01-01T23:59:59.000Z",
  "eventId" : "5ddfc8b646e0fb03956c31ba",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-11-28T13:16:38.706Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:16:38.707Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:16:38.707Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8b646e0fb03956c31ba"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8b646e0fb03956c31bb/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/5ddfc8e346e0fb03956c47e6 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 175

{
  "name" : "New Name",
  "start" : "2019-11-28T13:16:29.189Z",
  "end" : "2019-12-04T13:16:29.189Z",
  "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: Thu, 28 Nov 2019 13:17:23 GMT
Location: https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2545

{
  "id" : "5ddfc8e346e0fb03956c47e6",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-11-28T13:16:29.189Z",
  "end" : "2019-12-04T13:16:29.189Z",
  "eventId" : "5ddfc8e346e0fb03956c47e5",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-11-28T13:17:23.227Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:23.228Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:23.249Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8e346e0fb03956c47e5"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c47e6/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/5ddfc8e046e0fb03956c4544 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/5ddfc8e446e0fb03956c48af/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-11-28T13:17:24.670Z"
}

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/5ddfc8e346e0fb03956c4843/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/5ddfc8f546e0fb03956c498f/preview HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 80

{
  "lastModifiedDate" : "2019-11-28T13:17:41.408Z",
  "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" : "5ddfc8f546e0fb03956c499a",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8f546e0fb03956c499a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8f546e0fb03956c499a"
    }
  }
}

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/5ddfc8f646e0fb03956c4a67/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" : "5ddfc8f646e0fb03956c4a72",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8f646e0fb03956c4a72"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8f646e0fb03956c4a72"
    }
  }
}

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/5ddfc8f546e0fb03956c49fb/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/5ddfc8e146e0fb03956c4653/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" : {
    "findOneByPublishManifestId" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findOneByPublishManifestId"
    },
    "findByEvent" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5ddfc8e146e0fb03956c4653{&page,size,sort}",
      "templated" : true
    },
    "findOneByPublishingJobId" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findOneByPublishingJobId"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5ddfc8e146e0fb03956c4653/editions/search"
    }
  }
}

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/search/findByEvent?eventId=5ddfc8e146e0fb03956c4653 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" : "5ddfc8e146e0fb03956c4655",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-11-28T13:16:29.189Z",
      "end" : "2019-11-28T15:16:29.189Z",
      "eventId" : "5ddfc8e146e0fb03956c4653",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-11-28T13:17:21.052Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:21.052Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:21.052Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8e146e0fb03956c4653"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4655/slot-collisions"
        }
      }
    }, {
      "id" : "5ddfc8e146e0fb03956c4654",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-11-28T14:16:29.189Z",
      "end" : "2019-11-28T15:16:29.189Z",
      "eventId" : "5ddfc8e146e0fb03956c4653",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-11-28T13:17:21.041Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:21.042Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:21.042Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8e146e0fb03956c4653"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4654/slot-collisions"
        }
      }
    }, {
      "id" : "5ddfc8e146e0fb03956c4656",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-11-28T14:16:30.189Z",
      "end" : "2019-11-28T15:16:29.189Z",
      "eventId" : "5ddfc8e146e0fb03956c4653",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-11-28T13:17:21.063Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:21.063Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:21.063Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5ddfc8e146e0fb03956c4653"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e146e0fb03956c4656/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5ddfc8e146e0fb03956c4653&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5ddfc8e146e0fb03956c4653&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5ddfc8e146e0fb03956c4653&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/5ddfc8e246e0fb03956c4724/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" : "4f8a5aee-3a07-4738-ac0f-3484d675abb1",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e246e0fb03956c4724/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e246e0fb03956c4724"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e246e0fb03956c4724/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/5ddfc8e346e0fb03956c478b/conflicts/findByIdAndVersion?id=38e72e4b-7470-4d08-af65-73b5222c4059&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" : "5ddfc8e346e0fb03956c478b",
  "contentItemId" : "38e72e4b-7470-4d08-af65-73b5222c4059",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5ddfc8e346e0fb03956c478c",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:23.033Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5ddfc8e346e0fb03956c478e",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "38e72e4b-7470-4d08-af65-73b5222c4059",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c478b/conflicts/findByIdAndVersion?id=38e72e4b-7470-4d08-af65-73b5222c4059&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c478b"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e346e0fb03956c478b/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/5ddfc8e146e0fb03956c46b3/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-11-28T13:17:21.758Z",
  "resolutions" : [ {
    "contentItemId" : "cc2d0a1b-9d1d-43bb-8f71-424bc19fc5ba",
    "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/5ddfc8e046e0fb03956c45a2/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" : "5ddfc8e046e0fb03956c45a2",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-11-28T13:16:29.189Z",
    "endDateTime" : "2019-12-28T13:16:29.189Z",
    "editionId" : "5ddfc8e046e0fb03956c459d",
    "collidingSlotIds" : [ "54badcca-7e53-4179-a804-d664a7003356", "3abdc618-124e-4368-a648-2e1182b0be51" ],
    "eventName" : "Test",
    "eventId" : "5ddfc8e046e0fb03956c459c"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e046e0fb03956c45a2/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8e046e0fb03956c45a2/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/5ddfc8cc46e0fb03956c428d/slots?sourceEditionSlotId=5ddfc8cc46e0fb03956c428b HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5ddfc8cc46e0fb03956c428b

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: Thu, 28 Nov 2019 13:17:00 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1652

{
  "id" : "5ddfc8cc46e0fb03956c428e",
  "eventId" : "5ddfc8cc46e0fb03956c428c",
  "editionId" : "5ddfc8cc46e0fb03956c428d",
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:00.946Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:00.946Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5ddfc8cc46e0fb03956c4283",
  "slotId" : "c1a957d7-0576-4fe8-9e30-4acd48a0c24a",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8cc46e0fb03956c428d/slots/5ddfc8cc46e0fb03956c428e"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8cc46e0fb03956c428d/slots/5ddfc8cc46e0fb03956c428e"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8cc46e0fb03956c428d"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c1a957d7-0576-4fe8-9e30-4acd48a0c24a{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8cc46e0fb03956c428d/slots/5ddfc8cc46e0fb03956c428e/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8cc46e0fb03956c428d/slots/5ddfc8cc46e0fb03956c428e/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/5ddfc8dd46e0fb03956c435e/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: Thu, 28 Nov 2019 13:17:17 GMT
Location: https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "f34b452a-69d5-4e01-9d4a-da84c4c36132",
  "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-11-28T13:17:17.749Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:17.749Z",
  "deliveryId" : "f34b452a-69d5-4e01-9d4a-da84c4c36132",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f34b452a-69d5-4e01-9d4a-da84c4c36132"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc8dd46e0fb03956c435e"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f34b452a-69d5-4e01-9d4a-da84c4c36132",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f34b452a-69d5-4e01-9d4a-da84c4c36132{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132/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/5ddfc8df46e0fb03956c448a/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 167

[ {
  "slot" : "d0076b48-1a85-4cf5-858d-77376e232c2a"
}, {
  "slot" : "c17f0151-9f4b-4d1f-b4de-f17995d457e2"
}, {
  "slot" : "3001c95d-6fe1-4b1a-b9af-44aafb65123f"
} ]

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/5ddfc8df46e0fb03956c448a/slots
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6076

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5ddfc8df46e0fb03956c448e",
      "eventId" : "5ddfc8df46e0fb03956c4489",
      "editionId" : "5ddfc8df46e0fb03956c448a",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:19.528Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:19.528Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5ddfc8df46e0fb03956c4488",
      "slotId" : "d0076b48-1a85-4cf5-858d-77376e232c2a",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448e"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d0076b48-1a85-4cf5-858d-77376e232c2a{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448e/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448e/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8df46e0fb03956c448f",
      "eventId" : "5ddfc8df46e0fb03956c4489",
      "editionId" : "5ddfc8df46e0fb03956c448a",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:19.528Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:19.528Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5ddfc8df46e0fb03956c4488",
      "slotId" : "c17f0151-9f4b-4d1f-b4de-f17995d457e2",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448f"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448f"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c17f0151-9f4b-4d1f-b4de-f17995d457e2{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448f/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c448f/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8df46e0fb03956c4490",
      "eventId" : "5ddfc8df46e0fb03956c4489",
      "editionId" : "5ddfc8df46e0fb03956c448a",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:19.529Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:19.529Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5ddfc8df46e0fb03956c4488",
      "slotId" : "3001c95d-6fe1-4b1a-b9af-44aafb65123f",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c4490"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c4490"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3001c95d-6fe1-4b1a-b9af-44aafb65123f{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c4490/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots/5ddfc8df46e0fb03956c4490/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c448a/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/5ddfc8df46e0fb03956c447d/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" : "5ddfc8df46e0fb03956c4483",
      "eventId" : "5ddfc8df46e0fb03956c447c",
      "editionId" : "5ddfc8df46e0fb03956c447d",
      "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" : "5ddfc8df46e0fb03956c447b",
      "slotId" : "5d5b000b-591d-4993-a594-f58084ec3591",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4483"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4483"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5d5b000b-591d-4993-a594-f58084ec3591{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4483/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4483/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8df46e0fb03956c4481",
      "eventId" : "5ddfc8df46e0fb03956c447c",
      "editionId" : "5ddfc8df46e0fb03956c447d",
      "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" : "5ddfc8df46e0fb03956c447b",
      "slotId" : "ee3426e2-e874-4ed8-b854-48cd22da52ce",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4481"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4481"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ee3426e2-e874-4ed8-b854-48cd22da52ce{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4481/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c4481/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8df46e0fb03956c447f",
      "eventId" : "5ddfc8df46e0fb03956c447c",
      "editionId" : "5ddfc8df46e0fb03956c447d",
      "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" : "5ddfc8df46e0fb03956c447b",
      "slotId" : "c7d30990-e690-4460-aff1-93739a8974d2",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c447f"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c447f"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c7d30990-e690-4460-aff1-93739a8974d2{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c447f/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots/5ddfc8df46e0fb03956c447f/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c447d/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/5ddfc8df46e0fb03956c44ec/slots?includedSlots=6fceeab4-2c48-4e86-9def-2f2bef5c4dd2 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" : "5ddfc8df46e0fb03956c44ee",
      "eventId" : "5ddfc8df46e0fb03956c44e8",
      "editionId" : "5ddfc8df46e0fb03956c44ec",
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:17:19.962Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-11-28T13:17:19.962Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5ddfc8df46e0fb03956c44e7",
      "slotId" : "6fceeab4-2c48-4e86-9def-2f2bef5c4dd2",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots/5ddfc8df46e0fb03956c44ee"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots/5ddfc8df46e0fb03956c44ee"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fceeab4-2c48-4e86-9def-2f2bef5c4dd2{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots/5ddfc8df46e0fb03956c44ee/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots/5ddfc8df46e0fb03956c44ee/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots?includedSlots=6fceeab4-2c48-4e86-9def-2f2bef5c4dd2&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots?includedSlots=6fceeab4-2c48-4e86-9def-2f2bef5c4dd2&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8df46e0fb03956c44ec/slots?includedSlots=6fceeab4-2c48-4e86-9def-2f2bef5c4dd2&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/5ddfc8de46e0fb03956c43c0/slots/5ddfc8de46e0fb03956c43c2 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" : "5ddfc8de46e0fb03956c43c2",
  "eventId" : "5ddfc8de46e0fb03956c43bf",
  "editionId" : "5ddfc8de46e0fb03956c43c0",
  "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" : "5ddfc8de46e0fb03956c43be",
  "slotId" : "1fff0be9-1b7b-4354-a2aa-6c504e2582b6",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8de46e0fb03956c43c0/slots/5ddfc8de46e0fb03956c43c2"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8de46e0fb03956c43c0/slots/5ddfc8de46e0fb03956c43c2"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8de46e0fb03956c43c0"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1fff0be9-1b7b-4354-a2aa-6c504e2582b6{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8de46e0fb03956c43c0/slots/5ddfc8de46e0fb03956c43c2/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8de46e0fb03956c43c0/slots/5ddfc8de46e0fb03956c43c2/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/5ddfc8de46e0fb03956c441b/slots/5ddfc8de46e0fb03956c441d 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/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360/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" : "b4ce84af-20fd-4bc3-b627-d2fc147e5595",
        "locked" : true
      },
      "id" : "5ddfc8dd46e0fb03956c4366",
      "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: Thu, 28 Nov 2019 13:17:17 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5ddfc8dd46e0fb03956c4360",
  "eventId" : "5ddfc8dd46e0fb03956c435a",
  "editionId" : "5ddfc8dd46e0fb03956c435b",
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:17.771Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:17.965Z",
  "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" : "b4ce84af-20fd-4bc3-b627-d2fc147e5595",
          "locked" : true
        },
        "id" : "5ddfc8dd46e0fb03956c4366",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5ddfc8dd46e0fb03956c435d",
  "slotId" : "f34b452a-69d5-4e01-9d4a-da84c4c36132",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360/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/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360 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: Thu, 28 Nov 2019 13:17:17 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5ddfc8dd46e0fb03956c4360",
  "eventId" : "5ddfc8dd46e0fb03956c435a",
  "editionId" : "5ddfc8dd46e0fb03956c435b",
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:17.771Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:17.965Z",
  "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" : "b4ce84af-20fd-4bc3-b627-d2fc147e5595",
          "locked" : true
        },
        "id" : "5ddfc8dd46e0fb03956c4366",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5ddfc8dd46e0fb03956c435d",
  "slotId" : "f34b452a-69d5-4e01-9d4a-da84c4c36132",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f34b452a-69d5-4e01-9d4a-da84c4c36132{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c435b/slots/5ddfc8dd46e0fb03956c4360/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/5ddfc8dd46e0fb03956c4352/slots/5ddfc8dd46e0fb03956c4357 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: Thu, 28 Nov 2019 13:17:17 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1702

{
  "id" : "5ddfc8dd46e0fb03956c4357",
  "eventId" : "5ddfc8dd46e0fb03956c4351",
  "editionId" : "5ddfc8dd46e0fb03956c4352",
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:17.501Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:17.567Z",
  "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" : "5ddfc8dd46e0fb03956c4354",
  "slotId" : "21adcc08-383d-404e-b0c3-dd01e41535e0",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c4352/slots/5ddfc8dd46e0fb03956c4357"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c4352/slots/5ddfc8dd46e0fb03956c4357"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c4352"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/21adcc08-383d-404e-b0c3-dd01e41535e0{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c4352/slots/5ddfc8dd46e0fb03956c4357/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8dd46e0fb03956c4352/slots/5ddfc8dd46e0fb03956c4357/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/5ddfc8bf46e0fb03956c3d65/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" : "a6e101d8-9e0b-4b3e-9840-063f229314ca",
  "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/5ddfc8bf46e0fb03956c3d6c
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5ddfc8bf46e0fb03956c3d6c",
  "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" : "a6e101d8-9e0b-4b3e-9840-063f229314ca"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3d65"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a6e101d8-9e0b-4b3e-9840-063f229314ca"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d6c/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5ddfc8bf46e0fb03956c3dc0/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" : "5ddfc8c946e0fb03956c3dc7",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-11-28T13:16:57.925Z",
      "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" : "b3e3c201-65b6-48a4-8708-63f0ae1262e8"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e3c201-65b6-48a4-8708-63f0ae1262e8"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc7/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5ddfc8c946e0fb03956c3dc8",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-11-28T13:16:57.943Z",
      "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" : "97af899e-3de8-455e-a856-e9484eaf33a7"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97af899e-3de8-455e-a856-e9484eaf33a7"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8c946e0fb03956c3dc8/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8bf46e0fb03956c3dc0/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/5ddfc8bf46e0fb03956c3d11 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" : "5ddfc8bf46e0fb03956c3d11",
  "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" : "adb4b16e-c689-4c97-8aba-182312970ce8"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8be46e0fb03956c3d0b"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/adb4b16e-c689-4c97-8aba-182312970ce8"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bf46e0fb03956c3d11/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/5ddfc8be46e0fb03956c3c58/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

{
  "edition" : "5ddfc8be46e0fb03956c3c57"
}
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/5ddfc8be46e0fb03956c3c58/edition-links
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 396

{
  "editionId" : "5ddfc8be46e0fb03956c3c57",
  "createdDate" : "2019-11-28T13:16:46Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5ddfc8be46e0fb03956c3c57"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8be46e0fb03956c3c58/edition-links/5ddfc8be46e0fb03956c3c57"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
DELETE /v2/content/snapshots/5ddfc8be46e0fb03956c3cb5/edition-links/5ddfc8be46e0fb03956c3cb4 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/5ddfc8be46e0fb03956c3cb5/edition-links/5ddfc8be46e0fb03956c3cb4

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/5ddfc8bd46e0fb03956c3c32/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" : "5ddfc8bd46e0fb03956c3c38",
      "createdDate" : "2019-11-28T13:16:45Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8bd46e0fb03956c3c38"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links/5ddfc8bd46e0fb03956c3c38"
        }
      }
    }, {
      "editionId" : "5ddfc8bd46e0fb03956c3c39",
      "createdDate" : "2019-11-28T13:16:45Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8bd46e0fb03956c3c39"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links/5ddfc8bd46e0fb03956c3c39"
        }
      }
    }, {
      "editionId" : "5ddfc8bd46e0fb03956c3c3a",
      "createdDate" : "2019-11-28T13:16:45Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8bd46e0fb03956c3c3a"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links/5ddfc8bd46e0fb03956c3c3a"
        }
      }
    }, {
      "editionId" : "5ddfc8bd46e0fb03956c3c3b",
      "createdDate" : "2019-11-28T13:16:45Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8bd46e0fb03956c3c3b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links/5ddfc8bd46e0fb03956c3c3b"
        }
      }
    }, {
      "editionId" : "5ddfc8bd46e0fb03956c3c3c",
      "createdDate" : "2019-11-28T13:16:45Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5ddfc8bd46e0fb03956c3c3c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links/5ddfc8bd46e0fb03956c3c3c"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8bd46e0fb03956c3c32/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/5ddfc8ac46e0fb03956c288f/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-11-28T14:16:28.185Z"
}
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/5ddfc8ac46e0fb03956c2890
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5ddfc8ac46e0fb03956c2890",
  "scheduledDate" : "2019-11-28T14:16:28.185Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c2890"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c2890"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c288f"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c2890"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb 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" : "5ddfc8ac46e0fb03956c28eb",
  "scheduledDate" : "2019-11-28T15:16:28.333Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c28ea"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
    }
  }
}

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/5ddfc8ac46e0fb03956c2946 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" : "5ddfc8ac46e0fb03956c2946",
  "scheduledDate" : "2019-12-28T13:16:28.986Z",
  "createdDate" : "2019-11-28T13:16:28.996Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c2946"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c2946"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c2945"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/snapshots/5ddfc8ac46e0fb03956c28ea/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" : "5ddfc8ac46e0fb03956c28eb",
      "scheduledDate" : "2019-11-28T15:16:28.333Z",
      "createdDate" : "2017-06-05T04:03:02.000Z",
      "createdBy" : "user",
      "state" : "CREATED",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
        },
        "publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c28ea"
        },
        "cancel" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5ddfc8ac46e0fb03956c28eb"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c28ea/publishing-jobs?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c28ea/publishing-jobs?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5ddfc8ac46e0fb03956c28ea/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/5ddfc87a46e0fb03956c1dc2/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/5ddfc87a46e0fb03956c1dc3
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1058

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

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/5ddfc87a46e0fb03956c1e71/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/5ddfc87b46e0fb03956c1e72
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1180

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/folders/5ddfc87a46e0fb03956c1d6d 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" : "5ddfc87a46e0fb03956c1d6d",
  "name" : "A folder to end all folders",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1d6d"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1d6d"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1d6c"
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1d6c/content-items?folderId=5ddfc87a46e0fb03956c1d6d{&page,projection,size,sort,status}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1d6d/folders"
    },
    "delete-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1d6d"
    },
    "update-folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1d6d"
    }
  }
}

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/5ddfc87946e0fb03956c1cc0 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/5ddfc87946e0fb03956c1d15/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" : "5ddfc87946e0fb03956c1d16",
      "name" : "A folder to end all folders",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d16"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d16"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/content-items?folderId=5ddfc87946e0fb03956c1d16{&page,projection,size,sort,status}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d16/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d16"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d16"
        }
      }
    }, {
      "id" : "5ddfc87946e0fb03956c1d17",
      "name" : "Another Folder",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d17"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d17"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/content-items?folderId=5ddfc87946e0fb03956c1d17{&page,projection,size,sort,status}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d17/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d17"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87946e0fb03956c1d17"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/folders?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/folders?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/folders?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87946e0fb03956c1d15/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/5ddfc87a46e0fb03956c1e19/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" : "5ddfc87a46e0fb03956c1e1a",
      "name" : "Subfolder 1",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1a"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1a"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1e18"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1e18/content-items?folderId=5ddfc87a46e0fb03956c1e1a{&page,projection,size,sort,status}",
          "templated" : true
        },
        "parent-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19"
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1a/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1a"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1a"
        }
      }
    }, {
      "id" : "5ddfc87a46e0fb03956c1e1b",
      "name" : "Subfolder 2",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1b"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1b"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1e18"
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc87a46e0fb03956c1e18/content-items?folderId=5ddfc87a46e0fb03956c1e1b{&page,projection,size,sort,status}",
          "templated" : true
        },
        "parent-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19"
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1b/folders"
        },
        "delete-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1b"
        },
        "update-folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e1b"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19/folders?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19/folders?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19/folders?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/folders/5ddfc87a46e0fb03956c1e19/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/5ddfc87946e0fb03956c1c6a 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/5ddfc87946e0fb03956c1c6a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1039

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

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/5ddfc8b846e0fb03956c33c5/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/5ddfc8b846e0fb03956c33c5

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/5ddfc90046e0fb03956c5274/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: Thu, 28 Nov 2019 13:17:52 GMT
Location: https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3928

{
  "id" : "69513758-0864-4914-9493-b21c125fdd0c",
  "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-11-28T13:17:52.495Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:52.495Z",
  "deliveryId" : "69513758-0864-4914-9493-b21c125fdd0c",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=69513758-0864-4914-9493-b21c125fdd0c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90046e0fb03956c5274"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=69513758-0864-4914-9493-b21c125fdd0c",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=69513758-0864-4914-9493-b21c125fdd0c{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/69513758-0864-4914-9493-b21c125fdd0c/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/2b1f5143-d8ff-45b8-8726-6026c0bb0758/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" : "2b1f5143-d8ff-45b8-8726-6026c0bb0758",
  "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-11-28T13:17:52.215Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:52.287Z",
  "deliveryId" : "2b1f5143-d8ff-45b8-8726-6026c0bb0758",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2b1f5143-d8ff-45b8-8726-6026c0bb0758"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc90046e0fb03956c5269"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2b1f5143-d8ff-45b8-8726-6026c0bb0758",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2b1f5143-d8ff-45b8-8726-6026c0bb0758{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2b1f5143-d8ff-45b8-8726-6026c0bb0758/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/c1a59ca8-ee79-4a11-8403-2fe6d081acf2/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" : "c1a59ca8-ee79-4a11-8403-2fe6d081acf2"
  },
  "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/c1a59ca8-ee79-4a11-8403-2fe6d081acf2"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c1a59ca8-ee79-4a11-8403-2fe6d081acf2{&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/434ff89f-b57d-4e20-bed4-b1c91f2a5621/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" : "434ff89f-b57d-4e20-bed4-b1c91f2a5621",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/434ff89f-b57d-4e20-bed4-b1c91f2a5621"
        }
      }
    }, {
      "id" : "0cdf1546-bff8-4419-9f40-c03d4d97a4ec",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0cdf1546-bff8-4419-9f40-c03d4d97a4ec"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/434ff89f-b57d-4e20-bed4-b1c91f2a5621/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/434ff89f-b57d-4e20-bed4-b1c91f2a5621/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/434ff89f-b57d-4e20-bed4-b1c91f2a5621/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=de01ac11-9782-46bc-82da-dd99f4b8102f 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" : "de01ac11-9782-46bc-82da-dd99f4b8102f"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-11-28T13:16:39.267Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/de01ac11-9782-46bc-82da-dd99f4b8102f"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=de01ac11-9782-46bc-82da-dd99f4b8102f{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=de01ac11-9782-46bc-82da-dd99f4b8102f&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=de01ac11-9782-46bc-82da-dd99f4b8102f&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=de01ac11-9782-46bc-82da-dd99f4b8102f&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/5ddfc91246e0fb03956c54de/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" : "5ddfc91246e0fb03956c54de",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c54dd"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c54dd/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc91246e0fb03956c54dd/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/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/5ddfc91246e0fb03956c54de/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5ddfc91246e0fb03956c54de/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/5ddfc91346e0fb03956c55e6/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "newRepositoryId" : "5ddfc91346e0fb03956c55e4"
}
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/5ddfc91346e0fb03956c563d/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/5ddfc91346e0fb03956c563d/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"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/{id}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/{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/5ddfc8cc46e0fb03956c412f 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/5ddfc8cc46e0fb03956c412f"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c412f/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c412f/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/5ddfc8cb46e0fb03956c412d 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/5ddfc8cb46e0fb03956c412d"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cb46e0fb03956c412d/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cb46e0fb03956c412d/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/5ddfc8cc46e0fb03956c41d5/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/5ddfc8cc46e0fb03956c41d5/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c41d5/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/5ddfc8cc46e0fb03956c41d8/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/5ddfc8cc46e0fb03956c41d8/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/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/5ddfc8cc46e0fb03956c41d8/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5ddfc8cc46e0fb03956c41d8/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/5ddfc8cc46e0fb03956c422c/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/5ddfc8cc46e0fb03956c422c/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5ddfc8cc46e0fb03956c422c/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/5ddfc8cb46e0fb03956c40d6/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/5ddfc8cb46e0fb03956c40d8/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/5ddfc8f946e0fb03956c4d41/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/5ddfc8f946e0fb03956c4d41/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/5ddfc8f946e0fb03956c4d41/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d41"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d41/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d41/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d41/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d41/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/5ddfc8f946e0fb03956c4d3b/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/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/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/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/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/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3b/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/5ddfc8f846e0fb03956c4ce1/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/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/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/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/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/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4ce1/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/5ddfc8f946e0fb03956c4d4b/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/5ddfc8f946e0fb03956c4d4b/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d4b"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d4b/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d4b/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d4b/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d4b/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/hubs/5ddfc8f946e0fb03956c4d3f/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/5ddfc8f946e0fb03956c4d3f/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3f"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3f/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3f/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3f/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f946e0fb03956c4d3f/webhooks/5a497a000000000000000000"
    }
  }
}

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

DELETE /v2/content/hubs/5ddfc8f946e0fb03956c4d49/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/5ddfc8f746e0fb03956c4b87/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/5ddfc8f746e0fb03956c4b88
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 731

{
  "id" : "5ddfc8f746e0fb03956c4b88",
  "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/5ddfc8f746e0fb03956c4b88"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b88"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b87"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b88"
    }
  }
}

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5ddfc8f746e0fb03956c4b30/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" : "5ddfc8f746e0fb03956c4b32",
      "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/5ddfc8f746e0fb03956c4b32"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b32"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b32"
        }
      }
    }, {
      "id" : "5ddfc8f746e0fb03956c4b33",
      "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/5ddfc8f746e0fb03956c4b33"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b33"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b33"
        }
      }
    }, {
      "id" : "5ddfc8f746e0fb03956c4b31",
      "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/5ddfc8f746e0fb03956c4b31"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b31"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f746e0fb03956c4b31"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f746e0fb03956c4b30/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/5ddfc8f846e0fb03956c4c8d 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: Thu, 28 Nov 2019 13:17:44 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 729

{
  "id" : "5ddfc8f846e0fb03956c4c8d",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2019-11-28T13:17:44.217Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-11-28T13:17:44.217Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f846e0fb03956c4c8d"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f846e0fb03956c4c8d"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4c8c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f846e0fb03956c4c8d"
    }
  }
}

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/5ddfc8f846e0fb03956c4c38 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" : "5ddfc8f846e0fb03956c4c38",
  "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/5ddfc8f846e0fb03956c4c38"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f846e0fb03956c4c38"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8f846e0fb03956c4c37"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5ddfc8f846e0fb03956c4c38"
    }
  }
}

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/5ddfc8ca46e0fb03956c3e2b/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=5ddfc8ca46e0fb03956c3e2b"
        },
        "list-integrations" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc?hubId=5ddfc8ca46e0fb03956c3e2b{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2b/integrations?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2b/integrations?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2b/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/5ddfc8ca46e0fb03956c3e2f/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=5ddfc8ca46e0fb03956c3e2f"
        },
        "create-integration" : {
          "href" : "https://api.amplience.net/v2/content/integrations/sfcc"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2f/integrations?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2f/integrations?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5ddfc8ca46e0fb03956c3e2f/integrations?page=0&size=20&sort=label,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Extensions

Create an Extension

Auth rules

Snippet auth-rules not found for operation::"extension-create"

Example request

Snippet http-request not found for operation::"extension-create"

Example response

Snippet http-response not found for operation::"extension-create"

Listing Extensions

Auth rules

Snippet auth-rules not found for operation::"extension-list"

Example request

Snippet http-request not found for operation::"extension-list"

Example response

Snippet http-response not found for operation::"extension-list"

Get an Extension

Auth rules

Snippet auth-rules not found for operation::"extension-get"

Example request

Snippet http-request not found for operation::"extension-get"

Example response

Snippet http-response not found for operation::"extension-get"

Get an Extension by name

Auth rules

Snippet auth-rules not found for operation::"get-extension-by-name"

Example request

Snippet http-request not found for operation::"get-extension-by-name"

Example response

Snippet http-response not found for operation::"get-extension-by-name"

Update an Extension

Auth rules

Snippet auth-rules not found for operation::"extension-update"

Example request

Snippet http-request not found for operation::"extension-update"

Example response

Snippet http-response not found for operation::"extension-update"

Delete an Extension

Auth rules

Snippet auth-rules not found for operation::"extension-delete"

Example request

Snippet http-request not found for operation::"extension-delete"

Example response

Snippet http-response not found for operation::"extension-delete"