Expand all

Integrating with the API

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

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

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

Example request

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

Example response

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

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

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

Information

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

Supported Localization Settings

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

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Hubs

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

Creating a new Hub

Auth rules

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

Example request

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

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

Example response

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

{
  "id" : "5d1f7e1d46e0fb0361ea6719",
  "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-07-05T16:43:09.381Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:09.381Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/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/5d1f7e1d46e0fb0361ea6719/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea6719/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" : "5d1f7e1d46e0fb0361ea67af",
      "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-07-05T16:43:09.555Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:09.555Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/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/5d1f7e1d46e0fb0361ea67af/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67af/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e1d46e0fb0361ea67b0",
      "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-07-05T16:43:09.582Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:09.582Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/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/5d1f7e1d46e0fb0361ea67b0/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b0/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e1d46e0fb0361ea67b1",
      "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-07-05T16:43:09.611Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:09.611Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/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/5d1f7e1d46e0fb0361ea67b1/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1d46e0fb0361ea67b1/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/5d1f7e7046e0fb0361ea8263 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "5d1f7e7046e0fb0361ea8263",
  "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-07-05T16:44:32.889Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:32.889Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/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/5d1f7e7046e0fb0361ea8263/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/webhooks"
    },
    "integrations" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/integrations{?page,size,sort}",
      "templated" : true
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea8263/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/5d1f7e1c46e0fb0361ea6558 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 101

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

Example response

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

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

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

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

POST /v2/content/hubs/5d1f7e1c46e0fb0361ea64c2/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/5d1f7e1546e0fb0361ea6010/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/5d1f7e1546e0fb0361ea6013
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1124

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

Assign a Content Type to a Repository

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request

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

{
  "contentTypeId" : "5d1f7e4746e0fb0361ea70db"
}

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" : "5d1f7e4746e0fb0361ea70dc",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ {
    "hubContentTypeId" : "5d1f7e4746e0fb0361ea70db",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
  } ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea70d8"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea70d8/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea70d8/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/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/5d1f7e4746e0fb0361ea70dc/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea70dc/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/5d1f7e4746e0fb0361ea717a/content-types/5d1f7e4746e0fb0361ea7179 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" : "5d1f7e4746e0fb0361ea717a",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea7176"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea7176/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4746e0fb0361ea7176/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/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/5d1f7e4746e0fb0361ea717a/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4746e0fb0361ea717a/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/5d1f7e1446e0fb0361ea5ed2/content-types HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-types" : [ {
      "id" : "5d1f7e1446e0fb0361ea5ed5",
      "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/5d1f7e1446e0fb0361ea5ed5"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed5"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed5/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed5/schema"
        }
      }
    }, {
      "id" : "5d1f7e1446e0fb0361ea5ed7",
      "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/5d1f7e1446e0fb0361ea5ed7"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed7"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed7/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed7/schema"
        }
      }
    }, {
      "id" : "5d1f7e1446e0fb0361ea5ed9",
      "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/5d1f7e1446e0fb0361ea5ed9"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed9"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed9/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5d1f7e1446e0fb0361ea5ed9/schema"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1446e0fb0361ea5ed2/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1446e0fb0361ea5ed2/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1446e0fb0361ea5ed2/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1446e0fb0361ea5ed2/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/5d1f7e1346e0fb0361ea5e87 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

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

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

Update a Content Type

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/content-types/5d1f7e1346e0fb0361ea5e39 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/5d1f7e1346e0fb0361ea5e39
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1016

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

Get a Content Type Schema

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-types/5d1f7e1546e0fb0361ea5fc5/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" : "5d1f7e1546e0fb0361ea5fc2",
  "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/5d1f7e1546e0fb0361ea5fc5/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/5d1f7e1546e0fb0361ea5f75/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" : "5d1f7e1446e0fb0361ea5f72",
  "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/5d1f7e1546e0fb0361ea5f75/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/5d1f7e1046e0fb0361ea5c20/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/5d1f7e1046e0fb0361ea5c21
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

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

{
  "id" : "5d1f7e1246e0fb0361ea5deb",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1246e0fb0361ea5dea"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1246e0fb0361ea5dea/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e1246e0fb0361ea5dea/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/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/5d1f7e1246e0fb0361ea5deb/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1246e0fb0361ea5deb/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/5d1f7e4846e0fb0361ea721b/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/5d1f7e4846e0fb0361ea721f/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/5d1f7e4846e0fb0361ea7217/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" : "5d1f7e4846e0fb0361ea7219",
      "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/5d1f7e4846e0fb0361ea7219"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/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/5d1f7e4846e0fb0361ea7219/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea7219/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea7217/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/5d1f7e1246e0fb0361ea5d9f/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/5d1f7e1746e0fb0361ea6100/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" : "5d1f7e1746e0fb0361ea6104",
  "locale" : "en"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 05 Jul 2019 16:43:03 GMT
Location: https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "0a6e7e2e-64d9-4af0-b57a-9235d0badcb0",
  "folderId" : "5d1f7e1746e0fb0361ea6104",
  "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-07-05T16:43:03.712Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:03.712Z",
  "deliveryId" : "0a6e7e2e-64d9-4af0-b57a-9235d0badcb0",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1746e0fb0361ea6100"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0a6e7e2e-64d9-4af0-b57a-9235d0badcb0",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d1f7e1746e0fb0361ea6104"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0a6e7e2e-64d9-4af0-b57a-9235d0badcb0{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0a6e7e2e-64d9-4af0-b57a-9235d0badcb0/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0a6e7e2e-64d9-4af0-b57a-9235d0badcb0"
    }
  }
}

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/ddae3ff3-985a-47d1-9df9-a992da8905de HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "ddae3ff3-985a-47d1-9df9-a992da8905de",
  "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-07-05T16:43:03.197Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:03.197Z",
  "deliveryId" : "ddae3ff3-985a-47d1-9df9-a992da8905de",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1646e0fb0361ea60b0"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ddae3ff3-985a-47d1-9df9-a992da8905de",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ddae3ff3-985a-47d1-9df9-a992da8905de{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ddae3ff3-985a-47d1-9df9-a992da8905de/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ddae3ff3-985a-47d1-9df9-a992da8905de"
    }
  }
}

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/f8d03a11-5d88-4013-b8a2-2d8dc33957b6 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" : "5d1f7e1846e0fb0361ea6156"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 05 Jul 2019 16:43:04 GMT
Location: https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "f8d03a11-5d88-4013-b8a2-2d8dc33957b6",
  "folderId" : "5d1f7e1846e0fb0361ea6156",
  "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-07-05T16:43:04.116Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:04.177Z",
  "deliveryId" : "f8d03a11-5d88-4013-b8a2-2d8dc33957b6",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1746e0fb0361ea6152"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f8d03a11-5d88-4013-b8a2-2d8dc33957b6",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d1f7e1846e0fb0361ea6156"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f8d03a11-5d88-4013-b8a2-2d8dc33957b6{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/f8d03a11-5d88-4013-b8a2-2d8dc33957b6/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f8d03a11-5d88-4013-b8a2-2d8dc33957b6"
    }
  }
}

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/5d1f7e6746e0fb0361ea777b/content-items?sourceContentItemId=97afdc08-a6d2-41c3-ae1d-ee5753d35a3e HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 67

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 05 Jul 2019 16:44:23 GMT
Location: https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "bdd5fde7-7ced-41e0-aff2-e2346e40a98e",
  "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-07-05T16:44:23.705Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:23.705Z",
  "deliveryId" : "bdd5fde7-7ced-41e0-aff2-e2346e40a98e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6746e0fb0361ea777b"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bdd5fde7-7ced-41e0-aff2-e2346e40a98e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bdd5fde7-7ced-41e0-aff2-e2346e40a98e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bdd5fde7-7ced-41e0-aff2-e2346e40a98e/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bdd5fde7-7ced-41e0-aff2-e2346e40a98e"
    }
  }
}

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/5d1f7e6746e0fb0361ea7782/content-items?sourceContentItemId=503047b8-89da-4d01-8af4-65339cb54a60 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" : "5d1f7e6746e0fb0361ea7788"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 05 Jul 2019 16:44:23 GMT
Location: https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "e9133dea-1dce-490f-8bab-ac721cb51194",
  "folderId" : "5d1f7e6746e0fb0361ea7788",
  "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-07-05T16:44:23.913Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:23.913Z",
  "deliveryId" : "e9133dea-1dce-490f-8bab-ac721cb51194",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6746e0fb0361ea7782"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e9133dea-1dce-490f-8bab-ac721cb51194",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6746e0fb0361ea7788"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e9133dea-1dce-490f-8bab-ac721cb51194{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e9133dea-1dce-490f-8bab-ac721cb51194/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e9133dea-1dce-490f-8bab-ac721cb51194"
    }
  }
}

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/82e67f71-1d9a-491e-9b40-ebd91405275b/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" : "82e67f71-1d9a-491e-9b40-ebd91405275b",
  "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-07-05T16:43:55.788Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:55.808Z",
  "deliveryId" : "82e67f71-1d9a-491e-9b40-ebd91405275b",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4b46e0fb0361ea74a2"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=82e67f71-1d9a-491e-9b40-ebd91405275b",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=82e67f71-1d9a-491e-9b40-ebd91405275b{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/82e67f71-1d9a-491e-9b40-ebd91405275b/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=82e67f71-1d9a-491e-9b40-ebd91405275b"
    }
  }
}

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/978a5f32-d80a-40c7-9f0e-4517b9226d8f/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" : "978a5f32-d80a-40c7-9f0e-4517b9226d8f",
  "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" : "978a5f32-d80a-40c7-9f0e-4517b9226d8f",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea784f"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=978a5f32-d80a-40c7-9f0e-4517b9226d8f",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=978a5f32-d80a-40c7-9f0e-4517b9226d8f{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/978a5f32-d80a-40c7-9f0e-4517b9226d8f/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=978a5f32-d80a-40c7-9f0e-4517b9226d8f"
    }
  }
}

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" : "5d1f7e1946e0fb0361ea624c",
  "id" : "b6388902-e560-4b34-a55d-3e4f682b894f"
}, {
  "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" : "5d1f7e1946e0fb0361ea624c",
  "id" : "91db37da-153a-40cf-881d-c8d42dd6200a"
} ]

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: 226

{
  "results" : [ {
    "id" : "b6388902-e560-4b34-a55d-3e4f682b894f",
    "status" : 200,
    "description" : null
  }, {
    "id" : "91db37da-153a-40cf-881d-c8d42dd6200a",
    "status" : 200,
    "description" : 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/5d1f7e1846e0fb0361ea61a4/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" : "95ecb3d3-bad7-4734-9a19-63171925fbdc",
      "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-07-05T16:43:04.648Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:04.648Z",
      "deliveryId" : "95ecb3d3-bad7-4734-9a19-63171925fbdc",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=95ecb3d3-bad7-4734-9a19-63171925fbdc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=95ecb3d3-bad7-4734-9a19-63171925fbdc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/95ecb3d3-bad7-4734-9a19-63171925fbdc/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=95ecb3d3-bad7-4734-9a19-63171925fbdc"
        }
      }
    }, {
      "id" : "0e5afd69-e451-4aec-8931-b1df000dd065",
      "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-07-05T16:43:04.615Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:04.615Z",
      "deliveryId" : "0e5afd69-e451-4aec-8931-b1df000dd065",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0e5afd69-e451-4aec-8931-b1df000dd065",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0e5afd69-e451-4aec-8931-b1df000dd065{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0e5afd69-e451-4aec-8931-b1df000dd065/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0e5afd69-e451-4aec-8931-b1df000dd065"
        }
      }
    }, {
      "id" : "7281eaba-38e7-4243-a858-6fd571d90558",
      "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-07-05T16:43:04.580Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:04.580Z",
      "deliveryId" : "7281eaba-38e7-4243-a858-6fd571d90558",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7281eaba-38e7-4243-a858-6fd571d90558",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7281eaba-38e7-4243-a858-6fd571d90558{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7281eaba-38e7-4243-a858-6fd571d90558/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7281eaba-38e7-4243-a858-6fd571d90558"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61a4/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/5d1f7e6546e0fb0361ea75d1/content-items?projection=basic HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "createdBy" : "user",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "label" : "Banner Ad Homepage",
      "deliveryId" : "9ec32aff-c067-46cc-97aa-925124c83d6c",
      "folderId" : null,
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "locale" : "en",
      "version" : 1,
      "status" : "ACTIVE",
      "id" : "9ec32aff-c067-46cc-97aa-925124c83d6c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6546e0fb0361ea75d1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9ec32aff-c067-46cc-97aa-925124c83d6c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9ec32aff-c067-46cc-97aa-925124c83d6c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9ec32aff-c067-46cc-97aa-925124c83d6c/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9ec32aff-c067-46cc-97aa-925124c83d6c"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6546e0fb0361ea75d1/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6546e0fb0361ea75d1/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6546e0fb0361ea75d1/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6546e0fb0361ea75d1/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/5d1f7e1846e0fb0361ea61f6/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" : "f2b2b608-5d7f-4b49-b33f-0c6e9477f621",
      "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-07-05T16:43:05.094Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:05.094Z",
      "deliveryId" : "f2b2b608-5d7f-4b49-b33f-0c6e9477f621",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f2b2b608-5d7f-4b49-b33f-0c6e9477f621",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f2b2b608-5d7f-4b49-b33f-0c6e9477f621{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2b2b608-5d7f-4b49-b33f-0c6e9477f621/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f2b2b608-5d7f-4b49-b33f-0c6e9477f621"
        }
      }
    }, {
      "id" : "559d9d4d-a5c6-47c3-bb0d-1922a889a73a",
      "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-07-05T16:43:05.135Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:05.135Z",
      "deliveryId" : "559d9d4d-a5c6-47c3-bb0d-1922a889a73a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=559d9d4d-a5c6-47c3-bb0d-1922a889a73a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=559d9d4d-a5c6-47c3-bb0d-1922a889a73a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/559d9d4d-a5c6-47c3-bb0d-1922a889a73a/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=559d9d4d-a5c6-47c3-bb0d-1922a889a73a"
        }
      }
    }, {
      "id" : "19d50c2c-5f59-46f4-b8c0-d92dab08b3da",
      "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-07-05T16:43:05.176Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:05.176Z",
      "deliveryId" : "19d50c2c-5f59-46f4-b8c0-d92dab08b3da",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=19d50c2c-5f59-46f4-b8c0-d92dab08b3da",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=19d50c2c-5f59-46f4-b8c0-d92dab08b3da{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/19d50c2c-5f59-46f4-b8c0-d92dab08b3da/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=19d50c2c-5f59-46f4-b8c0-d92dab08b3da"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1846e0fb0361ea61f6/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/5d1f7e6846e0fb0361ea77e1/content-items?folderId=5d1f7e6846e0fb0361ea77e5 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" : "66339dc8-aa79-4618-b5e3-46b8be64774b",
      "folderId" : "5d1f7e6846e0fb0361ea77e5",
      "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-07-05T16:44:24.616Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.616Z",
      "deliveryId" : "66339dc8-aa79-4618-b5e3-46b8be64774b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77e1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=66339dc8-aa79-4618-b5e3-46b8be64774b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77e5"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=66339dc8-aa79-4618-b5e3-46b8be64774b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66339dc8-aa79-4618-b5e3-46b8be64774b/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=66339dc8-aa79-4618-b5e3-46b8be64774b"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77e1/content-items?folderId=5d1f7e6846e0fb0361ea77e5&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77e1/content-items?folderId=5d1f7e6846e0fb0361ea77e5&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77e1/content-items?folderId=5d1f7e6846e0fb0361ea77e5&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77e1/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/5d1f7e6846e0fb0361ea77d5/content-items?folderId=5d1f7e6846e0fb0361ea77d9,5d1f7e6846e0fb0361ea77da 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" : "68816d28-ed0e-4a80-9490-2e4bf5e7e22a",
      "folderId" : "5d1f7e6846e0fb0361ea77da",
      "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-07-05T16:44:24.354Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.354Z",
      "deliveryId" : "68816d28-ed0e-4a80-9490-2e4bf5e7e22a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=68816d28-ed0e-4a80-9490-2e4bf5e7e22a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77da"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=68816d28-ed0e-4a80-9490-2e4bf5e7e22a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/68816d28-ed0e-4a80-9490-2e4bf5e7e22a/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=68816d28-ed0e-4a80-9490-2e4bf5e7e22a"
        }
      }
    }, {
      "id" : "1203b233-a977-4081-abc0-edb1ab3ae07c",
      "folderId" : "5d1f7e6846e0fb0361ea77da",
      "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-07-05T16:44:24.326Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.326Z",
      "deliveryId" : "1203b233-a977-4081-abc0-edb1ab3ae07c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1203b233-a977-4081-abc0-edb1ab3ae07c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77da"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1203b233-a977-4081-abc0-edb1ab3ae07c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1203b233-a977-4081-abc0-edb1ab3ae07c/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1203b233-a977-4081-abc0-edb1ab3ae07c"
        }
      }
    }, {
      "id" : "ff4df534-40f3-44ef-8050-fa4dc964f34e",
      "folderId" : "5d1f7e6846e0fb0361ea77da",
      "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-07-05T16:44:24.297Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.297Z",
      "deliveryId" : "ff4df534-40f3-44ef-8050-fa4dc964f34e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ff4df534-40f3-44ef-8050-fa4dc964f34e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77da"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ff4df534-40f3-44ef-8050-fa4dc964f34e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ff4df534-40f3-44ef-8050-fa4dc964f34e/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ff4df534-40f3-44ef-8050-fa4dc964f34e"
        }
      }
    }, {
      "id" : "ba81e928-8385-47cd-9017-98e4ade90f5b",
      "folderId" : "5d1f7e6846e0fb0361ea77d9",
      "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-07-05T16:44:24.268Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.268Z",
      "deliveryId" : "ba81e928-8385-47cd-9017-98e4ade90f5b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ba81e928-8385-47cd-9017-98e4ade90f5b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77d9"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ba81e928-8385-47cd-9017-98e4ade90f5b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ba81e928-8385-47cd-9017-98e4ade90f5b/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ba81e928-8385-47cd-9017-98e4ade90f5b"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5/content-items?folderId=5d1f7e6846e0fb0361ea77d9,5d1f7e6846e0fb0361ea77da&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5/content-items?folderId=5d1f7e6846e0fb0361ea77d9,5d1f7e6846e0fb0361ea77da&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5/content-items?folderId=5d1f7e6846e0fb0361ea77d9,5d1f7e6846e0fb0361ea77da&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77d5/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/5d1f7e6846e0fb0361ea77ed/content-items?folderId=5d1f7e6846e0fb0361ea77f1&folderId=5d1f7e6846e0fb0361ea77f2 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" : "bbaf86fb-9e27-4619-9453-74eeeac1bd44",
      "folderId" : "5d1f7e6846e0fb0361ea77f2",
      "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-07-05T16:44:25.015Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:25.015Z",
      "deliveryId" : "bbaf86fb-9e27-4619-9453-74eeeac1bd44",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bbaf86fb-9e27-4619-9453-74eeeac1bd44",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77f2"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bbaf86fb-9e27-4619-9453-74eeeac1bd44{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bbaf86fb-9e27-4619-9453-74eeeac1bd44/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bbaf86fb-9e27-4619-9453-74eeeac1bd44"
        }
      }
    }, {
      "id" : "3a7c537f-a8e6-4a7f-9f1f-a9f497450345",
      "folderId" : "5d1f7e6846e0fb0361ea77f2",
      "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-07-05T16:44:24.988Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.988Z",
      "deliveryId" : "3a7c537f-a8e6-4a7f-9f1f-a9f497450345",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3a7c537f-a8e6-4a7f-9f1f-a9f497450345",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77f2"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3a7c537f-a8e6-4a7f-9f1f-a9f497450345{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a7c537f-a8e6-4a7f-9f1f-a9f497450345/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3a7c537f-a8e6-4a7f-9f1f-a9f497450345"
        }
      }
    }, {
      "id" : "2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e",
      "folderId" : "5d1f7e6846e0fb0361ea77f2",
      "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-07-05T16:44:24.968Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.968Z",
      "deliveryId" : "2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77f2"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2746a3bb-ca8a-4c2d-99a1-3fbc0f38b20e"
        }
      }
    }, {
      "id" : "b4ba44b0-050b-43b4-884b-9d65bbaef1f7",
      "folderId" : "5d1f7e6846e0fb0361ea77f1",
      "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-07-05T16:44:24.942Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:24.942Z",
      "deliveryId" : "b4ba44b0-050b-43b4-884b-9d65bbaef1f7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b4ba44b0-050b-43b4-884b-9d65bbaef1f7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6846e0fb0361ea77f1"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b4ba44b0-050b-43b4-884b-9d65bbaef1f7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4ba44b0-050b-43b4-884b-9d65bbaef1f7/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b4ba44b0-050b-43b4-884b-9d65bbaef1f7"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed/content-items?folderId=5d1f7e6846e0fb0361ea77f1&folderId=5d1f7e6846e0fb0361ea77f2&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed/content-items?folderId=5d1f7e6846e0fb0361ea77f1&folderId=5d1f7e6846e0fb0361ea77f2&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed/content-items?folderId=5d1f7e6846e0fb0361ea77f1&folderId=5d1f7e6846e0fb0361ea77f2&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6846e0fb0361ea77ed/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/5d1f7e6946e0fb0361ea77f9/content-items?folderId=!5d1f7e6946e0fb0361ea77fd 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" : "2a570e68-73af-4fd4-afb4-84842225dddc",
      "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-07-05T16:44:25.298Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:25.298Z",
      "deliveryId" : "2a570e68-73af-4fd4-afb4-84842225dddc",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2a570e68-73af-4fd4-afb4-84842225dddc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2a570e68-73af-4fd4-afb4-84842225dddc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a570e68-73af-4fd4-afb4-84842225dddc/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2a570e68-73af-4fd4-afb4-84842225dddc"
        }
      }
    }, {
      "id" : "fd8a5345-1cbd-43e2-9bd5-21089b348bb2",
      "folderId" : "5d1f7e6946e0fb0361ea77fe",
      "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-07-05T16:44:25.277Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:25.277Z",
      "deliveryId" : "fd8a5345-1cbd-43e2-9bd5-21089b348bb2",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fd8a5345-1cbd-43e2-9bd5-21089b348bb2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6946e0fb0361ea77fe"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fd8a5345-1cbd-43e2-9bd5-21089b348bb2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd8a5345-1cbd-43e2-9bd5-21089b348bb2/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fd8a5345-1cbd-43e2-9bd5-21089b348bb2"
        }
      }
    }, {
      "id" : "9f90eee8-ab96-483a-8f24-a0b8db99c60b",
      "folderId" : "5d1f7e6946e0fb0361ea77fe",
      "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-07-05T16:44:25.256Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:25.256Z",
      "deliveryId" : "9f90eee8-ab96-483a-8f24-a0b8db99c60b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9f90eee8-ab96-483a-8f24-a0b8db99c60b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6946e0fb0361ea77fe"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9f90eee8-ab96-483a-8f24-a0b8db99c60b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9f90eee8-ab96-483a-8f24-a0b8db99c60b/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9f90eee8-ab96-483a-8f24-a0b8db99c60b"
        }
      }
    }, {
      "id" : "4b1ab348-8ac7-4668-9979-56fb2035c005",
      "folderId" : "5d1f7e6946e0fb0361ea77fe",
      "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-07-05T16:44:25.235Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:25.235Z",
      "deliveryId" : "4b1ab348-8ac7-4668-9979-56fb2035c005",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4b1ab348-8ac7-4668-9979-56fb2035c005",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5d1f7e6946e0fb0361ea77fe"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4b1ab348-8ac7-4668-9979-56fb2035c005{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b1ab348-8ac7-4668-9979-56fb2035c005/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4b1ab348-8ac7-4668-9979-56fb2035c005"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9/content-items?folderId=!5d1f7e6946e0fb0361ea77fd&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9/content-items?folderId=!5d1f7e6946e0fb0361ea77fd&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9/content-items?folderId=!5d1f7e6946e0fb0361ea77fd&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6946e0fb0361ea77f9/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/9b088997-664d-4fc2-b1d8-69262bb209c5/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-07-05T16:43:53.811Z",
        "historyEventId" : "7b1d8d60-2c62-4ac6-b05c-d0d953dcf2da"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b26f2794-d228-4c5a-9dc7-755f47d17096",
        "createdDate" : "2019-06-25T16:43:53.818Z",
        "historyEventId" : "20b7a2f3-daa2-4f8f-9409-5c9b0f52f96a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "53e22a53-c3f8-46fa-83ef-dc65536f8357",
        "createdDate" : "2019-06-24T16:43:53.818Z",
        "historyEventId" : "013508a9-fd4a-4466-84fb-d13ed678daa4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "cb4222c8-45aa-4ca4-8a13-c0b1a58e8108",
        "createdDate" : "2019-06-23T16:43:53.818Z",
        "historyEventId" : "682739a9-49a7-486e-8b45-30dd66858191"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7bbcc63e-1152-41c7-b492-7e0cb4dd5309",
        "createdDate" : "2019-06-22T16:43:53.818Z",
        "historyEventId" : "52e8deeb-e093-424c-a90d-f00586a3d9d3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "da79b3bd-87a5-4f9e-8b1b-465f0feaeb5e",
        "createdDate" : "2019-06-21T16:43:53.818Z",
        "historyEventId" : "728b872a-26fe-4094-8978-f384e53e9670"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.809Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.765Z",
        "historyEventId" : "53eb6987-4aba-49f6-b77b-f4e2f606c6c0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "8bd03d20-ff6a-4f73-a082-a8d8470f4e24",
        "createdDate" : "2019-06-24T16:43:53.818Z",
        "historyEventId" : "ed8c29f6-f040-4d67-95b6-740d66bad4ef"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "faf3a611-5423-4f76-9a5a-c4937cd0bcc1",
        "createdDate" : "2019-06-23T16:43:53.818Z",
        "historyEventId" : "0f874f4a-bb69-4671-8ecd-a4652ee3448f"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1e22ba72-9243-4d85-aa45-75efa4d681d6",
        "createdDate" : "2019-06-22T16:43:53.818Z",
        "historyEventId" : "9d546ee2-f826-4321-bbd1-27f39454080a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "63c23c4e-74f6-46ba-a33b-33a55d0d8a6c",
        "createdDate" : "2019-06-21T16:43:53.818Z",
        "historyEventId" : "e4db15ed-e7fa-4f88-b4d7-b95f9f2d68b7"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "de93f450-3f4b-4d07-aa59-7c78f42a8bb2",
        "createdDate" : "2019-06-20T16:43:53.818Z",
        "historyEventId" : "325d98e1-04ca-4ad8-85c1-7d5d0d5efc18"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.764Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.725Z",
        "historyEventId" : "c1c7188b-1d10-447d-a5cd-e19bdb578103"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "260617d1-cfeb-4fa8-9ba6-1357993a90b9",
        "createdDate" : "2019-06-23T16:43:53.818Z",
        "historyEventId" : "3ed6af6e-e474-4e72-8352-3da148eda5cc"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9fb775b5-8ad7-407d-8bb6-80345fb84e75",
        "createdDate" : "2019-06-22T16:43:53.818Z",
        "historyEventId" : "96afe59c-fbc6-4497-9a86-d691ed93c03b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "3af41116-f2dd-43e9-b7ee-db95ae4ac0d2",
        "createdDate" : "2019-06-21T16:43:53.818Z",
        "historyEventId" : "4486bce3-6aa7-4247-88dc-a5067f18e23b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "03c258ae-fe50-43a9-bf6a-fa7eda42431c",
        "createdDate" : "2019-06-20T16:43:53.818Z",
        "historyEventId" : "04c2d51b-f107-40ce-b316-99ba5ab20503"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "cd48433c-3377-4d9d-abda-495bccf3dcf0",
        "createdDate" : "2019-06-19T16:43:53.818Z",
        "historyEventId" : "bcfe5a3b-a5ab-4f83-8261-dfe5808c91fa"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.723Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.687Z",
        "historyEventId" : "a5dca5df-2529-4ef8-bb72-86c842e2545a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7d16b49f-8bf5-4b4a-9aab-d70adea4d30b",
        "createdDate" : "2019-06-22T16:43:53.818Z",
        "historyEventId" : "3d90d67c-eada-4e56-868e-6ff5dd4fa806"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "07fc0eb0-1cee-4b0d-a0f7-8dbddf7ce7f0",
        "createdDate" : "2019-06-21T16:43:53.818Z",
        "historyEventId" : "bfdfaf85-440f-46a4-b831-c5645ad5f45a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7217c113-2a0c-4d77-8cf6-fc6668bbce74",
        "createdDate" : "2019-06-20T16:43:53.818Z",
        "historyEventId" : "ae106946-f86f-4e3e-99e6-6fb1ba8224f5"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "15b6963e-292e-4d56-a7c8-2f0870a19ad9",
        "createdDate" : "2019-06-19T16:43:53.818Z",
        "historyEventId" : "571cd53e-c60f-4a36-a007-848f451d8dc8"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "21360f96-0432-41e4-8802-3fc412f0c405",
        "createdDate" : "2019-06-18T16:43:53.818Z",
        "historyEventId" : "6cb8ff9b-4ec5-46a8-81e4-9bfd8ec17b0e"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.685Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.642Z",
        "historyEventId" : "798b7a1b-6256-4b83-b613-69ea1a350ca2"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "19ffd20a-8bcc-46dc-8b47-01a4f9c9d253",
        "createdDate" : "2019-06-21T16:43:53.818Z",
        "historyEventId" : "27a8274d-4b6e-4c00-8100-2c8cf95f8239"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b9e8d66f-ea51-4a1e-b073-c6607e562a5e",
        "createdDate" : "2019-06-20T16:43:53.818Z",
        "historyEventId" : "00a7d0ce-9157-4ac5-bd8e-7e3e586f8ae5"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "54169edc-e921-4491-b375-2dea3bb5ca38",
        "createdDate" : "2019-06-19T16:43:53.818Z",
        "historyEventId" : "4f9f0253-1b42-43b0-b4bb-92d8d00bcf40"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "c1783655-70df-47ca-aea3-77fa7682648a",
        "createdDate" : "2019-06-18T16:43:53.818Z",
        "historyEventId" : "d5f91422-a5d3-4c26-80d6-50d743e9e1d8"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "a4e515ae-ebd4-44f1-b5ca-5c914737227f",
        "createdDate" : "2019-06-17T16:43:53.818Z",
        "historyEventId" : "c955129e-a133-448a-924e-8cae6b841adc"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.640Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.603Z",
        "historyEventId" : "f6e9de67-3cfe-4527-ab8e-786aa16f8937"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9f52083e-bb3b-46f3-854b-ac59d4884e2a",
        "createdDate" : "2019-06-20T16:43:53.818Z",
        "historyEventId" : "49241352-55dc-4abf-b9c5-ce05977c37fd"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "86669411-9c33-4035-80b3-262e01792e37",
        "createdDate" : "2019-06-19T16:43:53.818Z",
        "historyEventId" : "59ed7764-c6bb-4ee4-8764-e7e9636826bc"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "88adb6a4-5403-42ae-b04b-d75f592029ab",
        "createdDate" : "2019-06-18T16:43:53.818Z",
        "historyEventId" : "b9547aa2-e1af-4056-9890-180626cd463b"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "713efa5f-36af-4900-bbe3-37e203e52f51",
        "createdDate" : "2019-06-17T16:43:53.818Z",
        "historyEventId" : "5ff0385f-4708-449b-8bf8-83e1af027a3f"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "dc201f8b-c58a-42eb-90be-e0d4cb4252bd",
        "createdDate" : "2019-06-16T16:43:53.818Z",
        "historyEventId" : "e6a890ab-56ed-4a10-aa3e-0a0d759a0eec"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.601Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.563Z",
        "historyEventId" : "ef0a9c97-fd7c-447d-936b-baa90e25b5d1"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "acb2c547-d267-4a99-bd21-1c6b8763cef9",
        "createdDate" : "2019-06-19T16:43:53.818Z",
        "historyEventId" : "08c3714b-2518-471d-adf2-f5c24b0591a7"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "a2de976c-c852-47e8-95a3-f5fda01b06f0",
        "createdDate" : "2019-06-18T16:43:53.818Z",
        "historyEventId" : "b711b7b4-e327-4c7f-811f-99d666f2d2bb"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "07a8dc37-f3c1-4ed1-a786-b49cf48d31c0",
        "createdDate" : "2019-06-17T16:43:53.818Z",
        "historyEventId" : "dbc55ee1-c308-4f11-bf28-aa38c0838664"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d9618271-4c55-4826-8359-6bd06a5fb3d1",
        "createdDate" : "2019-06-16T16:43:53.818Z",
        "historyEventId" : "547a2528-abab-4138-9ead-bc55a5d2e592"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.561Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.526Z",
        "historyEventId" : "d5170f79-a284-4cca-a46a-38d3f46cf0ba"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "b9e1f731-cb08-4851-8fa7-ad2c30acff89",
        "createdDate" : "2019-06-18T16:43:53.818Z",
        "historyEventId" : "c2b0a615-bb8e-447a-b08b-61eb6ae44e17"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "da61d27a-f706-4a96-b197-991552a7578c",
        "createdDate" : "2019-06-17T16:43:53.818Z",
        "historyEventId" : "05b1bf8d-c5be-483e-aa45-72acabb36e74"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "8ca79802-10c8-40f4-a251-4064a0db2111",
        "createdDate" : "2019-06-16T16:43:53.818Z",
        "historyEventId" : "8db9e474-e39a-4547-a7b9-305e7da94997"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.524Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.488Z",
        "historyEventId" : "29b1aa27-1f45-485e-ac8c-9bbb434c6af3"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "90d7619f-ed7a-4e40-81c8-d8a6a3d63362",
        "createdDate" : "2019-06-17T16:43:53.818Z",
        "historyEventId" : "513ada31-36b0-4c67-a62b-6e32446a01e5"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2ec2d34a-bc7d-48a0-9ecf-e1eae0197d97",
        "createdDate" : "2019-06-16T16:43:53.818Z",
        "historyEventId" : "6cf1cf91-00bd-4981-8fe8-c900eae72e9f"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.483Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:43:53.439Z",
        "historyEventId" : "7287bb14-462a-4ea4-8a64-99537519f1a0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "951a6bf7-0ba2-4d77-8b2e-38797341358f",
        "createdDate" : "2019-06-16T16:43:53.818Z",
        "historyEventId" : "f78c706e-eb4e-48ba-bdf4-e4a9ae53364d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:53.438Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9b088997-664d-4fc2-b1d8-69262bb209c5/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/c48fba01-e352-4ec4-8691-5695bd723eb7/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" : "dd3e3f06-1ac8-416e-ace8-395076f6743d",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-07-05T16:43:53.027Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0d3a7851-0d6c-4365-a4d3-3c43f2146c17",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-07-01T16:43:53.038Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "5578506a-e07f-4de4-93b4-2cf47835046a",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-30T16:43:53.038Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "e169839f-16cb-4114-8088-74e70f6a7769",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-29T16:43:53.038Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "452f36ef-8aa6-4460-9a78-cd974b6162e1",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-28T16:43:53.038Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0df9efcd-5036-4bf8-9183-2096ae2dfcf3",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-27T16:43:53.038Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "f89c6358-2688-4845-957f-4eb68b92b135",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-26T16:43:53.038Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "09836ea9-6580-42d8-9bb9-c357f615bff5",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-25T16:43:53.038Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "36346af5-56b5-4e50-b9e4-9b49b7b1f185",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-24T16:43:53.038Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "b5abe66b-47ab-4943-a2ce-cd69020adc0e",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-23T16:43:53.038Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "e198e1f2-17ef-4869-a92b-73ff16d53097",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-22T16:43:53.038Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "a5f31404-3cb3-4153-9620-3d774c3ec26c",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-21T16:43:53.038Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0ca5f07b-7bc2-444f-bb44-595d6aa87e91",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-20T16:43:53.038Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "0ec1025b-5511-4a4f-86ec-bdec26dab245",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-19T16:43:53.038Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "faa4c657-a268-41d5-a818-b2ea7d5828cf",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-18T16:43:53.038Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "277d527f-9ec8-4646-bec6-faf25758db88",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-17T16:43:53.038Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "bcda32a6-8ece-4b5b-bb09-9dac5baef5d1",
      "contentItemId" : "c48fba01-e352-4ec4-8691-5695bd723eb7",
      "version" : 1,
      "createdDate" : "2019-06-16T16:43:53.038Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c48fba01-e352-4ec4-8691-5695bd723eb7/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c48fba01-e352-4ec4-8691-5695bd723eb7/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c48fba01-e352-4ec4-8691-5695bd723eb7/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/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/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" : "5326050e-3ff5-402d-b83c-f1a4fc07d9f9",
      "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-07-05T16:43:54.222Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:54.277Z",
      "deliveryId" : "5326050e-3ff5-402d-b83c-f1a4fc07d9f9",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4946e0fb0361ea73a1"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5326050e-3ff5-402d-b83c-f1a4fc07d9f9"
        }
      }
    }, {
      "id" : "5326050e-3ff5-402d-b83c-f1a4fc07d9f9",
      "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-07-05T16:43:54.222Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:54.277Z",
      "deliveryId" : "5326050e-3ff5-402d-b83c-f1a4fc07d9f9",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4946e0fb0361ea73a1"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5326050e-3ff5-402d-b83c-f1a4fc07d9f9"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5326050e-3ff5-402d-b83c-f1a4fc07d9f9/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=3a39aa3b-ec4d-487b-8869-12e8671d8a4f 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" : "3a39aa3b-ec4d-487b-8869-12e8671d8a4f",
      "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" : "65ed1e84-459b-4c6a-9581-8ff3144b7c97"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:02.661Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:02.661Z",
      "deliveryId" : "3a39aa3b-ec4d-487b-8869-12e8671d8a4f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1646e0fb0361ea6061"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3a39aa3b-ec4d-487b-8869-12e8671d8a4f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3a39aa3b-ec4d-487b-8869-12e8671d8a4f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f/workflow"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3a39aa3b-ec4d-487b-8869-12e8671d8a4f"
        }
      }
    }, {
      "id" : "65ed1e84-459b-4c6a-9581-8ff3144b7c97",
      "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" : "b6f865f2-98c5-43d6-80f6-7adeb13bc330"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:02.620Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:02.620Z",
      "deliveryId" : "65ed1e84-459b-4c6a-9581-8ff3144b7c97",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1646e0fb0361ea6061"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=65ed1e84-459b-4c6a-9581-8ff3144b7c97",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=65ed1e84-459b-4c6a-9581-8ff3144b7c97{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/65ed1e84-459b-4c6a-9581-8ff3144b7c97/workflow"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=65ed1e84-459b-4c6a-9581-8ff3144b7c97"
        }
      }
    }, {
      "id" : "b6f865f2-98c5-43d6-80f6-7adeb13bc330",
      "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-07-05T16:43:02.472Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:02.472Z",
      "deliveryId" : "b6f865f2-98c5-43d6-80f6-7adeb13bc330",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1646e0fb0361ea6061"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b6f865f2-98c5-43d6-80f6-7adeb13bc330",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b6f865f2-98c5-43d6-80f6-7adeb13bc330{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b6f865f2-98c5-43d6-80f6-7adeb13bc330/workflow"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b6f865f2-98c5-43d6-80f6-7adeb13bc330"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3a39aa3b-ec4d-487b-8869-12e8671d8a4f"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a39aa3b-ec4d-487b-8869-12e8671d8a4f{?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/e80becda-7d0b-4b5b-b1bb-588236c92c4d/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" : "e80becda-7d0b-4b5b-b1bb-588236c92c4d",
  "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-07-05T16:43:07.838Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:07.838Z",
  "deliveryId" : "e80becda-7d0b-4b5b-b1bb-588236c92c4d",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e80becda-7d0b-4b5b-b1bb-588236c92c4d/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1b46e0fb0361ea6391"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e80becda-7d0b-4b5b-b1bb-588236c92c4d"
    }
  }
}

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/5072ab6b-6f9b-43ee-bda6-22d993ea899a/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" : "5072ab6b-6f9b-43ee-bda6-22d993ea899a",
  "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-07-05T16:43:07.261Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:07.395Z",
  "deliveryId" : "5072ab6b-6f9b-43ee-bda6-22d993ea899a",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5072ab6b-6f9b-43ee-bda6-22d993ea899a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1b46e0fb0361ea633e"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5072ab6b-6f9b-43ee-bda6-22d993ea899a"
    }
  }
}

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/423e83ef-9596-40c7-9816-bacd7155f2f0/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" : "423e83ef-9596-40c7-9816-bacd7155f2f0",
  "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-07-05T16:43:06.630Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:06.767Z",
  "deliveryId" : "423e83ef-9596-40c7-9816-bacd7155f2f0",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/423e83ef-9596-40c7-9816-bacd7155f2f0/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e1a46e0fb0361ea62ec"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=423e83ef-9596-40c7-9816-bacd7155f2f0"
    }
  }
}

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/474e00fc-3409-4374-a6c4-0468f57eddce/restore HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 43

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

Example response

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

{
  "id" : "474e00fc-3409-4374-a6c4-0468f57eddce",
  "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-07-05T16:44:23.188Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:23.296Z",
  "deliveryId" : "474e00fc-3409-4374-a6c4-0468f57eddce",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6646e0fb0361ea7727"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=474e00fc-3409-4374-a6c4-0468f57eddce",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=474e00fc-3409-4374-a6c4-0468f57eddce{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/474e00fc-3409-4374-a6c4-0468f57eddce/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=474e00fc-3409-4374-a6c4-0468f57eddce"
    }
  }
}

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/5d1f7e5146e0fb0361ea74f2/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" : "ec81dabc-a53a-4a7f-861b-cc9bb4daea5d",
      "contentRepositoryId" : "5d1f7e5146e0fb0361ea74f3",
      "folderId" : null,
      "deliveryId" : "ec81dabc-a53a-4a7f-861b-cc9bb4daea5d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:12.528Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:12.528Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e5146e0fb0361ea74f3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ec81dabc-a53a-4a7f-861b-cc9bb4daea5d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ec81dabc-a53a-4a7f-861b-cc9bb4daea5d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ec81dabc-a53a-4a7f-861b-cc9bb4daea5d/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e5146e0fb0361ea74f2/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e5146e0fb0361ea74f2/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e5146e0fb0361ea74f2/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/5d1f7e6046e0fb0361ea7543/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" : "6af5d63c-c1e9-4004-9988-01baacbffd92",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "6af5d63c-c1e9-4004-9988-01baacbffd92",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "36c0c2e9-b058-4f88-9a74-ae9f45b35fb4",
      "createdBy" : "user",
      "createdDate" : "2019-06-06T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-06T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6af5d63c-c1e9-4004-9988-01baacbffd92",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6af5d63c-c1e9-4004-9988-01baacbffd92{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6af5d63c-c1e9-4004-9988-01baacbffd92/workflow"
        }
      }
    }, {
      "id" : "cc4b527c-1aff-45e9-a6e7-6c44871853e1",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "cc4b527c-1aff-45e9-a6e7-6c44871853e1",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3bc8e371-771a-4f34-ba59-3b9ec4b28d34",
      "createdBy" : "user",
      "createdDate" : "2019-06-07T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-07T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cc4b527c-1aff-45e9-a6e7-6c44871853e1",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cc4b527c-1aff-45e9-a6e7-6c44871853e1{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc4b527c-1aff-45e9-a6e7-6c44871853e1/workflow"
        }
      }
    }, {
      "id" : "537d1689-0467-448f-8fa9-5cb07a24058f",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "537d1689-0467-448f-8fa9-5cb07a24058f",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "39a1ce02-717f-47c5-9be2-68605b403531",
      "createdBy" : "user",
      "createdDate" : "2019-06-08T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-08T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=537d1689-0467-448f-8fa9-5cb07a24058f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=537d1689-0467-448f-8fa9-5cb07a24058f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/537d1689-0467-448f-8fa9-5cb07a24058f/workflow"
        }
      }
    }, {
      "id" : "40974414-7449-428c-954a-8049cb726adc",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "40974414-7449-428c-954a-8049cb726adc",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "9f32a84a-313e-4e25-b699-0a77703530f0",
      "createdBy" : "user",
      "createdDate" : "2019-06-09T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-09T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=40974414-7449-428c-954a-8049cb726adc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=40974414-7449-428c-954a-8049cb726adc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/40974414-7449-428c-954a-8049cb726adc/workflow"
        }
      }
    }, {
      "id" : "4fea487a-8f41-4e76-98f5-91f607fc2084",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "4fea487a-8f41-4e76-98f5-91f607fc2084",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "83a7a792-3903-428c-b3af-59a3dc389e08",
      "createdBy" : "user",
      "createdDate" : "2019-06-10T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-10T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4fea487a-8f41-4e76-98f5-91f607fc2084",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4fea487a-8f41-4e76-98f5-91f607fc2084{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fea487a-8f41-4e76-98f5-91f607fc2084/workflow"
        }
      }
    }, {
      "id" : "36126522-d285-46ef-a6a5-1c861ac7f790",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "36126522-d285-46ef-a6a5-1c861ac7f790",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "04b2a3f5-a9a5-476e-a374-f795a85a88d3",
      "createdBy" : "user",
      "createdDate" : "2019-06-11T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-11T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=36126522-d285-46ef-a6a5-1c861ac7f790",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=36126522-d285-46ef-a6a5-1c861ac7f790{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/36126522-d285-46ef-a6a5-1c861ac7f790/workflow"
        }
      }
    }, {
      "id" : "9aa29fe8-7201-4cfd-8ee8-8ad88b925761",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "9aa29fe8-7201-4cfd-8ee8-8ad88b925761",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7bc9bf6e-0e1c-4c5e-9c74-ab4064df5896",
      "createdBy" : "user",
      "createdDate" : "2019-06-12T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-12T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9aa29fe8-7201-4cfd-8ee8-8ad88b925761",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9aa29fe8-7201-4cfd-8ee8-8ad88b925761{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9aa29fe8-7201-4cfd-8ee8-8ad88b925761/workflow"
        }
      }
    }, {
      "id" : "9b536d5f-b107-40c5-8154-b5614890ad1a",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "9b536d5f-b107-40c5-8154-b5614890ad1a",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "57cf8f31-3086-4798-8394-095b9f6ee646",
      "createdBy" : "user",
      "createdDate" : "2019-06-13T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-13T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9b536d5f-b107-40c5-8154-b5614890ad1a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9b536d5f-b107-40c5-8154-b5614890ad1a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9b536d5f-b107-40c5-8154-b5614890ad1a/workflow"
        }
      }
    }, {
      "id" : "af104a15-93ba-46fe-93f8-07d2a6da1cfb",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "af104a15-93ba-46fe-93f8-07d2a6da1cfb",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "9caa3438-b10e-46e6-883f-7835600b2814",
      "createdBy" : "user",
      "createdDate" : "2019-06-14T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-14T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=af104a15-93ba-46fe-93f8-07d2a6da1cfb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=af104a15-93ba-46fe-93f8-07d2a6da1cfb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/af104a15-93ba-46fe-93f8-07d2a6da1cfb/workflow"
        }
      }
    }, {
      "id" : "f49057e2-7a67-4923-b239-0756625102c7",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "f49057e2-7a67-4923-b239-0756625102c7",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "89f50fab-1685-4cd2-a9eb-52ef07afcc38",
      "createdBy" : "user",
      "createdDate" : "2019-06-15T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-15T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f49057e2-7a67-4923-b239-0756625102c7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f49057e2-7a67-4923-b239-0756625102c7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f49057e2-7a67-4923-b239-0756625102c7/workflow"
        }
      }
    }, {
      "id" : "aee3cf0b-c1af-44db-a3f2-bb582a09b8d6",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "aee3cf0b-c1af-44db-a3f2-bb582a09b8d6",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "9457df95-08bd-41e8-8a97-2bf5970eeead",
      "createdBy" : "user",
      "createdDate" : "2019-06-16T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-16T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=aee3cf0b-c1af-44db-a3f2-bb582a09b8d6",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=aee3cf0b-c1af-44db-a3f2-bb582a09b8d6{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aee3cf0b-c1af-44db-a3f2-bb582a09b8d6/workflow"
        }
      }
    }, {
      "id" : "41f88dcf-c78e-4e00-aca4-2c0f70d3f792",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "41f88dcf-c78e-4e00-aca4-2c0f70d3f792",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "ab0c79fd-6427-4f5b-9183-77081fcea129",
      "createdBy" : "user",
      "createdDate" : "2019-06-17T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-17T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=41f88dcf-c78e-4e00-aca4-2c0f70d3f792",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=41f88dcf-c78e-4e00-aca4-2c0f70d3f792{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41f88dcf-c78e-4e00-aca4-2c0f70d3f792/workflow"
        }
      }
    }, {
      "id" : "79326d6b-861a-42bc-ae56-9322cdbc4766",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "79326d6b-861a-42bc-ae56-9322cdbc4766",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "2b096c96-f76f-42fb-9148-5b9658da0bb0",
      "createdBy" : "user",
      "createdDate" : "2019-06-18T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-18T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=79326d6b-861a-42bc-ae56-9322cdbc4766",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=79326d6b-861a-42bc-ae56-9322cdbc4766{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/79326d6b-861a-42bc-ae56-9322cdbc4766/workflow"
        }
      }
    }, {
      "id" : "d96de39d-23c6-4171-b651-1c8c407315e9",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "d96de39d-23c6-4171-b651-1c8c407315e9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d33c2994-03d3-43d1-b5f8-f40733288ebb",
      "createdBy" : "user",
      "createdDate" : "2019-06-19T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-19T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d96de39d-23c6-4171-b651-1c8c407315e9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d96de39d-23c6-4171-b651-1c8c407315e9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d96de39d-23c6-4171-b651-1c8c407315e9/workflow"
        }
      }
    }, {
      "id" : "597b6df0-1fc9-4aeb-9079-53504fdcddda",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "597b6df0-1fc9-4aeb-9079-53504fdcddda",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "669ee140-258b-45a6-88c6-701829c1f670",
      "createdBy" : "user",
      "createdDate" : "2019-06-20T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-20T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=597b6df0-1fc9-4aeb-9079-53504fdcddda",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=597b6df0-1fc9-4aeb-9079-53504fdcddda{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/597b6df0-1fc9-4aeb-9079-53504fdcddda/workflow"
        }
      }
    }, {
      "id" : "13948bfd-972c-4e87-89b2-fc21889dfe64",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "13948bfd-972c-4e87-89b2-fc21889dfe64",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "0702f22f-d8f2-4b9f-a2c0-6370d4deec62",
      "createdBy" : "user",
      "createdDate" : "2019-06-21T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-21T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=13948bfd-972c-4e87-89b2-fc21889dfe64",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=13948bfd-972c-4e87-89b2-fc21889dfe64{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13948bfd-972c-4e87-89b2-fc21889dfe64/workflow"
        }
      }
    }, {
      "id" : "793e1106-e037-4d1b-b117-dffa00268b4b",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "793e1106-e037-4d1b-b117-dffa00268b4b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "a93625e7-e9e7-4566-b038-2a51a7584be8",
      "createdBy" : "user",
      "createdDate" : "2019-06-22T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-22T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=793e1106-e037-4d1b-b117-dffa00268b4b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=793e1106-e037-4d1b-b117-dffa00268b4b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/793e1106-e037-4d1b-b117-dffa00268b4b/workflow"
        }
      }
    }, {
      "id" : "4a6436e4-caea-4b50-891f-8efe4b7aa547",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "4a6436e4-caea-4b50-891f-8efe4b7aa547",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "6a79dd1e-b9f6-401e-934c-1dc347d77d32",
      "createdBy" : "user",
      "createdDate" : "2019-06-23T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-23T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4a6436e4-caea-4b50-891f-8efe4b7aa547",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4a6436e4-caea-4b50-891f-8efe4b7aa547{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4a6436e4-caea-4b50-891f-8efe4b7aa547/workflow"
        }
      }
    }, {
      "id" : "c9750989-915e-489d-8c50-3f960f8b8d3c",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "c9750989-915e-489d-8c50-3f960f8b8d3c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "128d4268-f6ca-4381-995f-3baa4fef9828",
      "createdBy" : "user",
      "createdDate" : "2019-06-24T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-24T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c9750989-915e-489d-8c50-3f960f8b8d3c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c9750989-915e-489d-8c50-3f960f8b8d3c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9750989-915e-489d-8c50-3f960f8b8d3c/workflow"
        }
      }
    }, {
      "id" : "56d85139-6b77-4143-8cbf-f592c1d953a3",
      "contentRepositoryId" : "5d1f7e6046e0fb0361ea7549",
      "folderId" : null,
      "deliveryId" : "56d85139-6b77-4143-8cbf-f592c1d953a3",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "c419edf1-638a-436c-8b20-79437ffefdd5",
      "createdBy" : "user",
      "createdDate" : "2019-06-25T16:44:16.183Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-06-25T16:44:16.183Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6046e0fb0361ea7549"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=56d85139-6b77-4143-8cbf-f592c1d953a3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=56d85139-6b77-4143-8cbf-f592c1d953a3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56d85139-6b77-4143-8cbf-f592c1d953a3/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6046e0fb0361ea7543/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6046e0fb0361ea7543/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6046e0fb0361ea7543/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6046e0fb0361ea7543/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/7cba790f-e9aa-4ef4-b59a-14961ac53ad2/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/5d1f7e6646e0fb0361ea7682

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/52c23ada-e903-4a84-aed9-766be6711304/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" : "52c23ada-e903-4a84-aed9-766be6711304",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5d1f7e4a46e0fb0361ea7449",
    "eventStart" : "2019-07-05T16:43:27.259Z",
    "eventEnd" : "2019-08-05T16:43:27.259Z",
    "editionTitle" : "Test",
    "editionId" : "5d1f7e4b46e0fb0361ea744a",
    "editionStart" : "2019-07-05T16:43:27.259Z",
    "editionEnd" : "2019-08-05T16:43:27.259Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5d1f7e4b46e0fb0361ea744f",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2019-07-05T16:43:55.453Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-07-05T16:43:55.424Z",
    "snapshotId" : "5d1f7e4b46e0fb0361ea7455",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4b46e0fb0361ea744a/slots/5d1f7e4b46e0fb0361ea744f"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4b46e0fb0361ea744a/slots/5d1f7e4b46e0fb0361ea744f/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/52c23ada-e903-4a84-aed9-766be6711304/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/3749a6a0-942c-4392-8ce3-f0246c833ad3/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

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

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" : "3749a6a0-942c-4392-8ce3-f0246c833ad3",
  "workflow" : {
    "state" : "5d1f7e8d46e0fb0361ea9164"
  },
  "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-07-05T16:45:01.482Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:45:01.516Z",
  "deliveryId" : "3749a6a0-942c-4392-8ce3-f0246c833ad3",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e8d46e0fb0361ea9162"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3749a6a0-942c-4392-8ce3-f0246c833ad3",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3749a6a0-942c-4392-8ce3-f0246c833ad3{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3749a6a0-942c-4392-8ce3-f0246c833ad3/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3749a6a0-942c-4392-8ce3-f0246c833ad3"
    }
  }
}

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

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

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

{
  "name" : "shoes",
  "start" : "2019-07-05T17:45:00.680Z",
  "end" : "2019-07-05T20:45:00.680Z",
  "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/5d1f7e8c46e0fb0361ea902d
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1239

{
  "id" : "5d1f7e8c46e0fb0361ea902d",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-07-05T17:45:00.680Z",
  "end" : "2019-07-05T20:45:00.680Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8c46e0fb0361ea902c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea902d/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/5d1f7e8c46e0fb0361ea8fe1 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=5d1f7e8546e0fb0361ea8830&rangeEnd=2019-07-08T16:44:53.861Z&rangeStart=2019-07-02T16:44:53.861Z&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" : "5d1f7e8646e0fb0361ea8838",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-06-29T16:44:53.861Z",
      "end" : "2019-07-02T16:44:53.861Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8546e0fb0361ea8830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8838/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8546e0fb0361ea8836",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-06-29T16:44:53.861Z",
      "end" : "2019-07-03T16:44:53.861Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8546e0fb0361ea8830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8836/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8546e0fb0361ea8834",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-07-05T16:44:53.861Z",
      "end" : "2019-07-07T16:44:53.861Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8546e0fb0361ea8830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8834/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8546e0fb0361ea8835",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-07-07T16:44:53.861Z",
      "end" : "2019-07-11T16:44:53.861Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8546e0fb0361ea8830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8835/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8546e0fb0361ea8837",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-07-08T16:44:53.861Z",
      "end" : "2019-07-11T16:44:53.861Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8546e0fb0361ea8830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea8837/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8546e0fb0361ea8830&rangeStart=2019-07-02T16:44:53.861Z&rangeEnd=2019-07-08T16:44:53.861Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8546e0fb0361ea8830&rangeStart=2019-07-02T16:44:53.861Z&rangeEnd=2019-07-08T16:44:53.861Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8546e0fb0361ea8830&rangeStart=2019-07-02T16:44:53.861Z&rangeEnd=2019-07-08T16:44:53.861Z&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=5d1f7e8b46e0fb0361ea8f32&rangeEnd=2019-07-08T16:44:59.650Z&rangeStart=2019-07-02T16:44:59.650Z&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" : "5d1f7e8b46e0fb0361ea8f33",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-07-06T16:44:59.650Z",
      "end" : "2019-07-07T16:44:59.650Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5d1f7e8b46e0fb0361ea8f34",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-07-06T16:44:59.650Z",
        "end" : "2019-07-07T16:44:59.650Z",
        "eventId" : "5d1f7e8b46e0fb0361ea8f33",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:59.765Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:59.766Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:59.766Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8b46e0fb0361ea8f32"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f33/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f32&rangeStart=2019-07-02T16:44:59.650Z&rangeEnd=2019-07-08T16:44:59.650Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f32&rangeStart=2019-07-02T16:44:59.650Z&rangeEnd=2019-07-08T16:44:59.650Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f32&rangeStart=2019-07-02T16:44:59.650Z&rangeEnd=2019-07-08T16:44:59.650Z&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=5d1f7e8b46e0fb0361ea8f39&rangeStart=2019-07-05T16:44:59.897Z&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" : "5d1f7e8b46e0fb0361ea8f3d",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-07-03T16:44:59.897Z",
      "end" : "2019-07-07T16:44:59.897Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8b46e0fb0361ea8f39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3d/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8b46e0fb0361ea8f3c",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-07-05T16:44:59.897Z",
      "end" : "2019-07-07T16:44:59.897Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8b46e0fb0361ea8f39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3c/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e8b46e0fb0361ea8f3b",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-07-06T16:44:59.897Z",
      "end" : "2019-07-07T16:44:59.897Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8b46e0fb0361ea8f39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f3b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f39&rangeStart=2019-07-05T16:44:59.897Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f39&rangeStart=2019-07-05T16:44:59.897Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8b46e0fb0361ea8f39&rangeStart=2019-07-05T16:44:59.897Z&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=5d1f7e8c46e0fb0361ea8f40&rangeEnd=2019-07-04T23: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" : "5d1f7e8c46e0fb0361ea8f44",
      "name" : "Yesterday",
      "comment" : "This is an event.",
      "start" : "2019-07-04T00:00:00.000Z",
      "end" : "2019-07-04T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8c46e0fb0361ea8f40"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f44/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-07-04T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-07-04T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-07-04T23: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=5d1f7e8c46e0fb0361ea8f40&rangeEnd=2019-07-05T23:59:59.999Z&rangeStart=2019-07-05T00: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" : "5d1f7e8c46e0fb0361ea8f48",
      "name" : "Yesterday to Today",
      "comment" : "This is an event.",
      "start" : "2019-07-04T00:00:00.000Z",
      "end" : "2019-07-05T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8c46e0fb0361ea8f40"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f48/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-05T00:00:00.000Z&rangeEnd=2019-07-05T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-05T00:00:00.000Z&rangeEnd=2019-07-05T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-05T00:00:00.000Z&rangeEnd=2019-07-05T23:59:59.999Z&bounded=false&page=1&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-05T00:00:00.000Z&rangeEnd=2019-07-05T23: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=5d1f7e8c46e0fb0361ea8f40&rangeEnd=2019-07-06T23:59:59.999Z&rangeStart=2019-07-06T00: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" : "5d1f7e8c46e0fb0361ea8f46",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-07-06T00:00:00.000Z",
      "end" : "2019-07-06T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8c46e0fb0361ea8f40"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8c46e0fb0361ea8f46/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-06T00:00:00.000Z&rangeEnd=2019-07-06T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-06T00:00:00.000Z&rangeEnd=2019-07-06T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5d1f7e8c46e0fb0361ea8f40&rangeStart=2019-07-06T00:00:00.000Z&rangeEnd=2019-07-06T23: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=5d1f7e8b46e0fb0361ea8f21&rangeEnd=2019-07-08T16:44:59.417Z&rangeStart=2019-07-02T16:44:59.417Z&bounded=0&slots=642100b6-5ad0-4382-adbd-1fb472015f7c&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" : "5d1f7e8b46e0fb0361ea8f25",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-07-05T16:44:59.417Z",
      "end" : "2019-07-07T16:44:59.417Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8b46e0fb0361ea8f21"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8b46e0fb0361ea8f25/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8b46e0fb0361ea8f21&rangeStart=2019-07-02T16:44:59.417Z&rangeEnd=2019-07-08T16:44:59.417Z&bounded=false&slots=642100b6-5ad0-4382-adbd-1fb472015f7c&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8b46e0fb0361ea8f21&rangeStart=2019-07-02T16:44:59.417Z&rangeEnd=2019-07-08T16:44:59.417Z&bounded=false&slots=642100b6-5ad0-4382-adbd-1fb472015f7c&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8b46e0fb0361ea8f21&rangeStart=2019-07-02T16:44:59.417Z&rangeEnd=2019-07-08T16:44:59.417Z&bounded=false&slots=642100b6-5ad0-4382-adbd-1fb472015f7c&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=5d1f7e8646e0fb0361ea883b&rangeEnd=2019-07-08T16:44:54.129Z&rangeStart=2019-07-02T16:44:54.129Z&bounded=0&projection=withEditions&slots=af004067-db43-4def-92f5-84d0c81e0b97&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" : "5d1f7e8646e0fb0361ea8841",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-07-05T16:44:54.129Z",
      "end" : "2019-07-07T16:44:54.129Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5d1f7e8646e0fb0361ea8842",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.263Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.263Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.288Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8844",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.300Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.301Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.323Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8847",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.334Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.334Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.358Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea884b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.368Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.369Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.395Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8850",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.405Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.405Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.434Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8856",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.445Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.446Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.474Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea885d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.488Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.489Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.517Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8865",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.527Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.528Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.553Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea886e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.564Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.565Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.594Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8878",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.605Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.605Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.633Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea8883",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.644Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.644Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.681Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea888f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.698Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.698Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.743Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea889c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.754Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.754Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.786Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea88aa",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.797Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.797Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.832Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea88b9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.843Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.843Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.876Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea88c9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.886Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.887Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.925Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea88da",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.940Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.941Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:54.976Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8646e0fb0361ea88ec",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:54.987Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:54.988Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.027Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea88ff",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.039Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.039Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.079Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8913",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.090Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.091Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.128Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8928",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.140Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.140Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.179Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea893e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.190Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.190Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.230Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8955",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.240Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.241Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.290Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea896d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.301Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.301Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.341Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8986",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.351Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.352Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.392Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea89a0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.402Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.403Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.446Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea89bb",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.458Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.459Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.509Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea89d7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.519Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.520Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.564Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea89f4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.574Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.575Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.617Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8a12",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.628Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.628Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.673Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8a31",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.685Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.686Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.737Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8a51",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.749Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.749Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.805Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8a72",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.816Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.817Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.869Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8a94",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.880Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.881Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.936Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8746e0fb0361ea8ab7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:55.947Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:55.948Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:55.999Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8adb",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.010Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.011Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.064Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8b00",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.075Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.075Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.126Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8b26",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.136Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.136Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.190Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8b4d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.200Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.200Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.252Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8b75",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.262Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.263Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.316Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8b9e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.327Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.327Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.384Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8bc8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.395Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.395Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.455Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8bf3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.466Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.466Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.527Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8c1f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.541Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.541Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.600Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8c4c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.611Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.611Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.666Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8c7a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.676Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.676Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.733Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8ca9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.747Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.748Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.812Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8cd9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.823Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.823Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.888Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8d0a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.899Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.900Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:56.963Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5d1f7e8846e0fb0361ea8d3c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-07-05T16:44:54.129Z",
        "end" : "2019-07-07T16:44:54.129Z",
        "eventId" : "5d1f7e8646e0fb0361ea8841",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-07-05T16:44:56.976Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-07-05T16:44:56.977Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-07-05T16:44:57.043Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8646e0fb0361ea883b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8646e0fb0361ea8841/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8646e0fb0361ea883b&rangeStart=2019-07-02T16:44:54.129Z&rangeEnd=2019-07-08T16:44:54.129Z&bounded=false&slots=af004067-db43-4def-92f5-84d0c81e0b97&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8646e0fb0361ea883b&rangeStart=2019-07-02T16:44:54.129Z&rangeEnd=2019-07-08T16:44:54.129Z&bounded=false&slots=af004067-db43-4def-92f5-84d0c81e0b97&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5d1f7e8646e0fb0361ea883b&rangeStart=2019-07-02T16:44:54.129Z&rangeEnd=2019-07-08T16:44:54.129Z&bounded=false&slots=af004067-db43-4def-92f5-84d0c81e0b97&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/5d1f7e8546e0fb0361ea87e4/editions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 179

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

Example response

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

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

{
  "name" : "Test",
  "start" : "2019-07-05T16:43:27.259Z",
  "end" : "2019-08-05T16:43:27.259Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

{
  "id" : "5d1f7e3246e0fb0361ea6c90",
  "name" : "Test",
  "comment" : "This is an example edition.",
  "start" : "2019-07-05T16:43:27.259Z",
  "end" : "2019-08-05T16:43:27.259Z",
  "eventId" : "5d1f7e3246e0fb0361ea6c80",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 197,
  "versionConflicts" : {
    "limitExceeded" : false,
    "conflicts" : 0
  },
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-07-05T16:43:30.751Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:43:30.752Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:30.752Z",
  "stagedDate" : null,
  "slotCollisions" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/preview"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e3246e0fb0361ea6c80"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3246e0fb0361ea6c90/slot-collisions"
    }
  }
}

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5d1f7e8546e0fb0361ea87e4/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" : "5d1f7e8546e0fb0361ea87e5",
      "name" : "January Sale",
      "comment" : "This is an example edition.",
      "start" : "2017-01-01T00:00:00.000Z",
      "end" : "2017-01-01T23:59:59.000Z",
      "eventId" : "5d1f7e8546e0fb0361ea87e4",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-07-05T16:44:53.728Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:53.729Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:53.729Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/preview"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea87e4"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea87e5/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea87e4/editions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea87e4/editions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea87e4/editions?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e8546e0fb0361ea87e4/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/5d1f7e8546e0fb0361ea87e5 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

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

{
  "name" : "New Name",
  "start" : "2019-07-05T16:43:27.259Z",
  "end" : "2019-07-11T16:43:27.259Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

{
  "id" : "5d1f7e3146e0fb0361ea6b4a",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-07-05T16:43:27.259Z",
  "end" : "2019-07-11T16:43:27.259Z",
  "eventId" : "5d1f7e3146e0fb0361ea6b49",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-07-05T16:43:29.558Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:43:29.562Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:43:29.600Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/preview"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5d1f7e3146e0fb0361ea6b49"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b4a/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/5d1f7e3246e0fb0361ea6be6 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/5d1f7e2f46e0fb0361ea6a8c/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-07-05T16:43:27.994Z"
}

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

{
  "lastModifiedDate" : "2019-07-05T16:43:46.625Z",
  "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" : "5d1f7e4246e0fb0361ea6dbe",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e4246e0fb0361ea6dbe"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e4246e0fb0361ea6dbe"
    }
  }
}

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

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/5d1f7e4346e0fb0361ea6e16/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/5d1f7e3146e0fb0361ea6b96/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=5d1f7e3146e0fb0361ea6b96{&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/5d1f7e3146e0fb0361ea6b96/editions/search"
    }
  }
}

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/search/findByEvent?eventId=5d1f7e3146e0fb0361ea6b96 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" : "5d1f7e3146e0fb0361ea6b98",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-07-05T16:43:27.259Z",
      "end" : "2019-07-05T18:43:27.259Z",
      "eventId" : "5d1f7e3146e0fb0361ea6b96",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-07-05T16:43:29.754Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:29.755Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:29.755Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/preview"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e3146e0fb0361ea6b96"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b98/slot-collisions"
        }
      }
    }, {
      "id" : "5d1f7e3146e0fb0361ea6b97",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-07-05T17:43:27.259Z",
      "end" : "2019-07-05T18:43:27.259Z",
      "eventId" : "5d1f7e3146e0fb0361ea6b96",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-07-05T16:43:29.734Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:29.735Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:29.735Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/preview"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e3146e0fb0361ea6b96"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b97/slot-collisions"
        }
      }
    }, {
      "id" : "5d1f7e3146e0fb0361ea6b99",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-07-05T17:43:28.259Z",
      "end" : "2019-07-05T18:43:27.259Z",
      "eventId" : "5d1f7e3146e0fb0361ea6b96",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-07-05T16:43:29.770Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:29.771Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:43:29.771Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/preview"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5d1f7e3146e0fb0361ea6b96"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e3146e0fb0361ea6b99/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d1f7e3146e0fb0361ea6b96&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d1f7e3146e0fb0361ea6b96&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5d1f7e3146e0fb0361ea6b96&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/5d1f7e4546e0fb0361ea6f39/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" : "b722469e-9b32-4617-880b-cebf348fc8bd",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4546e0fb0361ea6f39/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4546e0fb0361ea6f39"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4546e0fb0361ea6f39/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/5d1f7e4346e0fb0361ea6e78/conflicts/findByIdAndVersion?id=bc137170-c771-4090-853b-065e5e9d4196&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" : "5d1f7e4346e0fb0361ea6e78",
  "contentItemId" : "bc137170-c771-4090-853b-065e5e9d4196",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5d1f7e4346e0fb0361ea6e79",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:47.787Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5d1f7e4346e0fb0361ea6e7b",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "bc137170-c771-4090-853b-065e5e9d4196",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4346e0fb0361ea6e78/conflicts/findByIdAndVersion?id=bc137170-c771-4090-853b-065e5e9d4196&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4346e0fb0361ea6e78"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4346e0fb0361ea6e78/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/5d1f7e4446e0fb0361ea6ed1/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-07-05T16:43:48.618Z",
  "resolutions" : [ {
    "contentItemId" : "3784d001-b842-4384-9989-7a01e578329f",
    "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/5d1f7e4546e0fb0361ea6f95/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" : "5d1f7e4546e0fb0361ea6f95",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-07-05T16:43:27.259Z",
    "endDateTime" : "2019-08-05T16:43:27.259Z",
    "editionId" : "5d1f7e4546e0fb0361ea6f90",
    "collidingSlotIds" : [ "64729008-b274-4d1e-a0e1-e471c9ae601c", "089b8381-443d-4351-8dad-a87d82ffc17b" ],
    "eventName" : "Test",
    "eventId" : "5d1f7e4546e0fb0361ea6f8f"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4546e0fb0361ea6f95/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e4546e0fb0361ea6f95/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/5d1f7e7446e0fb0361ea85c2/slots?sourceEditionSlotId=5d1f7e7446e0fb0361ea85c0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5d1f7e7446e0fb0361ea85c0

Example response

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

{
  "id" : "5d1f7e7446e0fb0361ea85c3",
  "eventId" : "5d1f7e7446e0fb0361ea85c1",
  "editionId" : "5d1f7e7446e0fb0361ea85c2",
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:44:36.644Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:36.644Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d1f7e7446e0fb0361ea85b8",
  "slotId" : "2615b1f6-257f-43ba-9a03-a9a5bcf35038",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea85c2/slots/5d1f7e7446e0fb0361ea85c3"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea85c2/slots/5d1f7e7446e0fb0361ea85c3"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea85c2"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2615b1f6-257f-43ba-9a03-a9a5bcf35038{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea85c2/slots/5d1f7e7446e0fb0361ea85c3/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea85c2/slots/5d1f7e7446e0fb0361ea85c3/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/5d1f7e8546e0fb0361ea878f/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 169

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 05 Jul 2019 16:44:53 GMT
Location: https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063",
  "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-07-05T16:44:53.380Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:53.380Z",
  "deliveryId" : "d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e8546e0fb0361ea878f"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063"
    }
  }
}

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/5d1f7e7546e0fb0361ea8626/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 167

[ {
  "slot" : "ad1edd5c-9d27-4fd9-a96e-34a0c69da104"
}, {
  "slot" : "cc5fa909-2d72-479f-bb96-75cdba5bf841"
}, {
  "slot" : "0fb960fb-a313-464e-8956-ab735fdeef63"
} ]

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

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5d1f7e7546e0fb0361ea862a",
      "eventId" : "5d1f7e7546e0fb0361ea8625",
      "editionId" : "5d1f7e7546e0fb0361ea8626",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:37.532Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:37.532Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d1f7e7546e0fb0361ea8624",
      "slotId" : "ad1edd5c-9d27-4fd9-a96e-34a0c69da104",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862a"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862a"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad1edd5c-9d27-4fd9-a96e-34a0c69da104{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862a/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862a/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e7546e0fb0361ea862c",
      "eventId" : "5d1f7e7546e0fb0361ea8625",
      "editionId" : "5d1f7e7546e0fb0361ea8626",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:37.533Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:37.533Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d1f7e7546e0fb0361ea8624",
      "slotId" : "cc5fa909-2d72-479f-bb96-75cdba5bf841",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862c"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc5fa909-2d72-479f-bb96-75cdba5bf841{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862c/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862c/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e7546e0fb0361ea862b",
      "eventId" : "5d1f7e7546e0fb0361ea8625",
      "editionId" : "5d1f7e7546e0fb0361ea8626",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:37.533Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:37.533Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d1f7e7546e0fb0361ea8624",
      "slotId" : "0fb960fb-a313-464e-8956-ab735fdeef63",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862b"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862b"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0fb960fb-a313-464e-8956-ab735fdeef63{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862b/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots/5d1f7e7546e0fb0361ea862b/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea8626/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/5d1f7e7546e0fb0361ea861a/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" : "5d1f7e7546e0fb0361ea8620",
      "eventId" : "5d1f7e7546e0fb0361ea8619",
      "editionId" : "5d1f7e7546e0fb0361ea861a",
      "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" : "5d1f7e7546e0fb0361ea8618",
      "slotId" : "5ee1a635-b27c-46a8-bfc3-c7c7784c9289",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea8620"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea8620"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5ee1a635-b27c-46a8-bfc3-c7c7784c9289{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea8620/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea8620/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e7546e0fb0361ea861e",
      "eventId" : "5d1f7e7546e0fb0361ea8619",
      "editionId" : "5d1f7e7546e0fb0361ea861a",
      "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" : "5d1f7e7546e0fb0361ea8618",
      "slotId" : "fa1560ba-1ba0-4b05-a70f-18c643b9dc8d",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861e"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa1560ba-1ba0-4b05-a70f-18c643b9dc8d{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861e/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861e/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e7546e0fb0361ea861c",
      "eventId" : "5d1f7e7546e0fb0361ea8619",
      "editionId" : "5d1f7e7546e0fb0361ea861a",
      "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" : "5d1f7e7546e0fb0361ea8618",
      "slotId" : "21fe9bee-2da0-4c5b-8f7f-ca6124d284e7",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861c"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/21fe9bee-2da0-4c5b-8f7f-ca6124d284e7{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861c/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots/5d1f7e7546e0fb0361ea861c/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea861a/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/5d1f7e7546e0fb0361ea867f/slots?includedSlots=d46b37bc-5281-4fe3-97ca-601ae16576c3 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" : "5d1f7e7546e0fb0361ea8680",
      "eventId" : "5d1f7e7546e0fb0361ea867b",
      "editionId" : "5d1f7e7546e0fb0361ea867f",
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:44:37.957Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-07-05T16:44:37.957Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5d1f7e7546e0fb0361ea867a",
      "slotId" : "d46b37bc-5281-4fe3-97ca-601ae16576c3",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots/5d1f7e7546e0fb0361ea8680"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots/5d1f7e7546e0fb0361ea8680"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d46b37bc-5281-4fe3-97ca-601ae16576c3{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots/5d1f7e7546e0fb0361ea8680/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots/5d1f7e7546e0fb0361ea8680/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots?includedSlots=d46b37bc-5281-4fe3-97ca-601ae16576c3&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots?includedSlots=d46b37bc-5281-4fe3-97ca-601ae16576c3&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7546e0fb0361ea867f/slots?includedSlots=d46b37bc-5281-4fe3-97ca-601ae16576c3&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/5d1f7e7446e0fb0361ea8568/slots/5d1f7e7446e0fb0361ea856a 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" : "5d1f7e7446e0fb0361ea856a",
  "eventId" : "5d1f7e7446e0fb0361ea8567",
  "editionId" : "5d1f7e7446e0fb0361ea8568",
  "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" : "5d1f7e7446e0fb0361ea8566",
  "slotId" : "c8e40dc8-ce0d-4478-9a08-4605a428870a",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea8568/slots/5d1f7e7446e0fb0361ea856a"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea8568/slots/5d1f7e7446e0fb0361ea856a"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea8568"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c8e40dc8-ce0d-4478-9a08-4605a428870a{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea8568/slots/5d1f7e7446e0fb0361ea856a/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e7446e0fb0361ea8568/slots/5d1f7e7446e0fb0361ea856a/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/5d1f7e7646e0fb0361ea86d1/slots/5d1f7e7646e0fb0361ea86d3 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/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791/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" : "b63e348a-51e6-4a80-b4ca-b8667dc4f2b3",
        "locked" : true
      },
      "id" : "5d1f7e8546e0fb0361ea8797",
      "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    }
  },
  "label" : "Simple Slot"
}

Example response

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

{
  "id" : "5d1f7e8546e0fb0361ea8791",
  "eventId" : "5d1f7e8546e0fb0361ea878b",
  "editionId" : "5d1f7e8546e0fb0361ea878c",
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:44:53.400Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:53.568Z",
  "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" : "b63e348a-51e6-4a80-b4ca-b8667dc4f2b3",
          "locked" : true
        },
        "id" : "5d1f7e8546e0fb0361ea8797",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d1f7e8546e0fb0361ea878e",
  "slotId" : "d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791/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/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "5d1f7e8546e0fb0361ea8791",
  "eventId" : "5d1f7e8546e0fb0361ea878b",
  "editionId" : "5d1f7e8546e0fb0361ea878c",
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:44:53.400Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:53.568Z",
  "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" : "b63e348a-51e6-4a80-b4ca-b8667dc4f2b3",
          "locked" : true
        },
        "id" : "5d1f7e8546e0fb0361ea8797",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5d1f7e8546e0fb0361ea878e",
  "slotId" : "d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d8d3ce8b-ae07-4ee0-88e8-3cad9c3ae063{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8546e0fb0361ea878c/slots/5d1f7e8546e0fb0361ea8791/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/5d1f7e8446e0fb0361ea8784/slots/5d1f7e8546e0fb0361ea8789 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "5d1f7e8546e0fb0361ea8789",
  "eventId" : "5d1f7e8446e0fb0361ea8783",
  "editionId" : "5d1f7e8446e0fb0361ea8784",
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:44:53.155Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:53.217Z",
  "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" : "5d1f7e8446e0fb0361ea8786",
  "slotId" : "542e330c-6952-426f-a26b-5868b244f3fd",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8446e0fb0361ea8784/slots/5d1f7e8546e0fb0361ea8789"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8446e0fb0361ea8784/slots/5d1f7e8546e0fb0361ea8789"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8446e0fb0361ea8784"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542e330c-6952-426f-a26b-5868b244f3fd{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8446e0fb0361ea8784/slots/5d1f7e8546e0fb0361ea8789/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e8446e0fb0361ea8784/slots/5d1f7e8546e0fb0361ea8789/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/5d1f7e7046e0fb0361ea81bc/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" : "dee71ba4-1786-4725-a5ef-35e38d4750f5",
  "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/5d1f7e7046e0fb0361ea81c3
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5d1f7e7046e0fb0361ea81c3",
  "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" : "dee71ba4-1786-4725-a5ef-35e38d4750f5"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7046e0fb0361ea81bc"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dee71ba4-1786-4725-a5ef-35e38d4750f5"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e7046e0fb0361ea81c3/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d1f7e6f46e0fb0361ea815d/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" : "5d1f7e6f46e0fb0361ea8164",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-07-05T16:44:31.763Z",
      "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" : "ea35df5e-6028-4a07-bd8a-506744fdf25d"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ea35df5e-6028-4a07-bd8a-506744fdf25d"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8164/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5d1f7e6f46e0fb0361ea8165",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-07-05T16:44:31.776Z",
      "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" : "b2de87a9-a2da-400d-92cb-4d6f0dfd1af1"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2de87a9-a2da-400d-92cb-4d6f0dfd1af1"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6f46e0fb0361ea8165/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6f46e0fb0361ea815d/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/5d1f7e6a46e0fb0361ea78a6 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" : "5d1f7e6a46e0fb0361ea78a6",
  "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" : "2f3c7b55-d47e-4098-ac8b-68478f6b92cc"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e6946e0fb0361ea78a0"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2f3c7b55-d47e-4098-ac8b-68478f6b92cc"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78a6/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/5d1f7e6b46e0fb0361ea791e/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

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

{
  "editionId" : "5d1f7e6b46e0fb0361ea791d",
  "createdDate" : "2019-07-05T16:44:27Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6b46e0fb0361ea791d"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6b46e0fb0361ea791e/edition-links/5d1f7e6b46e0fb0361ea791d"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5d1f7e6a46e0fb0361ea78f9/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" : "5d1f7e6a46e0fb0361ea78ff",
      "createdDate" : "2019-07-05T16:44:27Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6a46e0fb0361ea78ff"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links/5d1f7e6a46e0fb0361ea78ff"
        }
      }
    }, {
      "editionId" : "5d1f7e6a46e0fb0361ea7900",
      "createdDate" : "2019-07-05T16:44:27Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6a46e0fb0361ea7900"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links/5d1f7e6a46e0fb0361ea7900"
        }
      }
    }, {
      "editionId" : "5d1f7e6a46e0fb0361ea7901",
      "createdDate" : "2019-07-05T16:44:27Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6a46e0fb0361ea7901"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links/5d1f7e6a46e0fb0361ea7901"
        }
      }
    }, {
      "editionId" : "5d1f7e6a46e0fb0361ea7902",
      "createdDate" : "2019-07-05T16:44:27Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6a46e0fb0361ea7902"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links/5d1f7e6a46e0fb0361ea7902"
        }
      }
    }, {
      "editionId" : "5d1f7e6a46e0fb0361ea7903",
      "createdDate" : "2019-07-05T16:44:27Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5d1f7e6a46e0fb0361ea7903"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links/5d1f7e6a46e0fb0361ea7903"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e6a46e0fb0361ea78f9/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/5d1f7e8e46e0fb0361ea929e/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-07-05T17:45:02.266Z"
}
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/5d1f7e8e46e0fb0361ea929f
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5d1f7e8e46e0fb0361ea929f",
  "scheduledDate" : "2019-07-05T17:45:02.266Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea929f"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea929f"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e8e46e0fb0361ea929e"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea929f"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea924d 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" : "5d1f7e8e46e0fb0361ea924d",
  "scheduledDate" : "2019-07-05T18:45:01.754Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea924d"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea924d"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e8e46e0fb0361ea924c"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea924d"
    }
  }
}

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/5d1f7e8e46e0fb0361ea92f1 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" : "5d1f7e8e46e0fb0361ea92f1",
  "scheduledDate" : "2019-08-05T16:45:02.612Z",
  "createdDate" : "2019-07-05T16:45:02.620Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea92f1"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5d1f7e8e46e0fb0361ea92f1"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5d1f7e8e46e0fb0361ea92f0"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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

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

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

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

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

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

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

{
  "id" : "67283cc1-f874-4e8a-8ac1-b6399fac80d5",
  "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-07-05T16:44:22.804Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:22.804Z",
  "deliveryId" : "67283cc1-f874-4e8a-8ac1-b6399fac80d5",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6646e0fb0361ea76d5"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=67283cc1-f874-4e8a-8ac1-b6399fac80d5",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=67283cc1-f874-4e8a-8ac1-b6399fac80d5{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/67283cc1-f874-4e8a-8ac1-b6399fac80d5/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=67283cc1-f874-4e8a-8ac1-b6399fac80d5"
    }
  }
}
Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request
POST /v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/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" : "277ad383-9f8f-477c-82e2-f6ffcb738cb4",
  "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-07-05T16:44:22.630Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:44:22.649Z",
  "deliveryId" : "277ad383-9f8f-477c-82e2-f6ffcb738cb4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e6646e0fb0361ea76ce"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=277ad383-9f8f-477c-82e2-f6ffcb738cb4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=277ad383-9f8f-477c-82e2-f6ffcb738cb4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/277ad383-9f8f-477c-82e2-f6ffcb738cb4/workflow"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=277ad383-9f8f-477c-82e2-f6ffcb738cb4"
    }
  }
}

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/30f1e049-e127-4a43-8b69-9f00b6467fe6/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" : "30f1e049-e127-4a43-8b69-9f00b6467fe6"
  },
  "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/30f1e049-e127-4a43-8b69-9f00b6467fe6"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=30f1e049-e127-4a43-8b69-9f00b6467fe6{&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/13d3fd07-69f2-4054-9dc3-b99e8a476d22/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" : "13d3fd07-69f2-4054-9dc3-b99e8a476d22",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/13d3fd07-69f2-4054-9dc3-b99e8a476d22"
        }
      }
    }, {
      "id" : "dcd36c35-42e6-4a29-b2d8-1c4a3d8979b3",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dcd36c35-42e6-4a29-b2d8-1c4a3d8979b3"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/13d3fd07-69f2-4054-9dc3-b99e8a476d22/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/13d3fd07-69f2-4054-9dc3-b99e8a476d22/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/13d3fd07-69f2-4054-9dc3-b99e8a476d22/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=c5a1a925-d1cd-4aa9-96df-94b4238530c2 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" : "c5a1a925-d1cd-4aa9-96df-94b4238530c2"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-07-05T16:43:50.741Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5a1a925-d1cd-4aa9-96df-94b4238530c2"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c5a1a925-d1cd-4aa9-96df-94b4238530c2{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c5a1a925-d1cd-4aa9-96df-94b4238530c2&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c5a1a925-d1cd-4aa9-96df-94b4238530c2&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c5a1a925-d1cd-4aa9-96df-94b4238530c2&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/5d1f7e4846e0fb0361ea726b/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" : "5d1f7e4846e0fb0361ea726b",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea726a"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea726a/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e4846e0fb0361ea726a/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/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/5d1f7e4846e0fb0361ea726b/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5d1f7e4846e0fb0361ea726b/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/5d1f7e4746e0fb0361ea712a/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "newRepositoryId" : "5d1f7e4746e0fb0361ea7128"
}
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/5d1f7e4746e0fb0361ea71c7/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/5d1f7e4746e0fb0361ea71c7/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/5d1f7e7346e0fb0361ea8482 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/5d1f7e7346e0fb0361ea8482"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea8482/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea8482/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/5d1f7e7346e0fb0361ea8481 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/5d1f7e7346e0fb0361ea8481"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea8481/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea8481/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/5d1f7e7346e0fb0361ea839e/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/5d1f7e7346e0fb0361ea839e/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea839e/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/5d1f7e7346e0fb0361ea83a0/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/5d1f7e7346e0fb0361ea83a0/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/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/5d1f7e7346e0fb0361ea83a0/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5d1f7e7346e0fb0361ea83a0/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/5d1f7e7346e0fb0361ea83eb/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/5d1f7e7346e0fb0361ea83eb/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5d1f7e7346e0fb0361ea83eb/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/5d1f7e7346e0fb0361ea8517/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/5d1f7e7346e0fb0361ea8518/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

Note: Supported Webhook events:-

  • dynamic-content.edition.scheduled

  • dynamic-content.edition.unscheduled

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5d1f7e7146e0fb0361ea8300/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/5d1f7e7146e0fb0361ea8300/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/5d1f7e7146e0fb0361ea8300/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea8300"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea8300/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea8300/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea8300/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea8300/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/5d1f7e7146e0fb0361ea82fd/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/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/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/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/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/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7146e0fb0361ea82fd/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/5d1f7e7246e0fb0361ea8351/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/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/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/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/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/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8351/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/5d1f7e7246e0fb0361ea8305/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/5d1f7e7246e0fb0361ea8305/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8305"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8305/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8305/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8305/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e7246e0fb0361ea8305/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5d1f7e8d46e0fb0361ea9110/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" : "5d1f7e8d46e0fb0361ea9112",
      "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/5d1f7e8d46e0fb0361ea9112"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9112"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9112"
        }
      }
    }, {
      "id" : "5d1f7e8d46e0fb0361ea9113",
      "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/5d1f7e8d46e0fb0361ea9113"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9113"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9113"
        }
      }
    }, {
      "id" : "5d1f7e8d46e0fb0361ea9111",
      "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/5d1f7e8d46e0fb0361ea9111"
        },
        "workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9111"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8d46e0fb0361ea9111"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110/workflow-states?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8d46e0fb0361ea9110/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/5d1f7e8c46e0fb0361ea9079 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "5d1f7e8c46e0fb0361ea9079",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2019-07-05T16:45:00.918Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-07-05T16:45:00.918Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8c46e0fb0361ea9079"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8c46e0fb0361ea9079"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5d1f7e8c46e0fb0361ea9078"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5d1f7e8c46e0fb0361ea9079"
    }
  }
}

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

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