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 gives identifies 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: Wed, 16 Jan 2019 08:52:25 GMT
Location: https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3460

{
  "id" : "5c3ef0c94cedfd01c048d03a",
  "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-01-16T08:52:25.241Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:25.241Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/events"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-types"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-types{?page,size,sort}",
      "templated" : true
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03a/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    }
  }
}

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

{
  "_embedded" : {
    "hubs" : [ {
      "id" : "5c3ef0c84cedfd01c048d035",
      "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-01-16T08:52:24.880Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:24.880Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-types"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-types{?page,size,sort}",
          "templated" : true
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d035/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        }
      }
    }, {
      "id" : "5c3ef0c84cedfd01c048d036",
      "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-01-16T08:52:24.905Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:24.905Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-types"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-types{?page,size,sort}",
          "templated" : true
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d036/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        }
      }
    }, {
      "id" : "5c3ef0c84cedfd01c048d037",
      "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-01-16T08:52:24.928Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:24.928Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-types"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-types{?page,size,sort}",
          "templated" : true
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c84cedfd01c048d037/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        }
      }
    } ]
  },
  "_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/5c3ef12e4cedfd01c048e5c7 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: Wed, 16 Jan 2019 08:54:06 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3741

{
  "id" : "5c3ef12e4cedfd01c048e5c7",
  "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-01-16T08:54:06.181Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:54:06.181Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/events"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/content-types"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/content-types{?page,size,sort}",
      "templated" : true
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/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/5c3ef12e4cedfd01c048e5c7/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12e4cedfd01c048e5c7/webhooks"
    }
  }
}

Updating a Hub

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request

PATCH /v2/content/hubs/5c3ef0c94cedfd01c048d03d 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: Wed, 16 Jan 2019 08:52:25 GMT
Location: https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3464

{
  "id" : "5c3ef0c94cedfd01c048d03d",
  "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-01-16T08:52:25.543Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:25.568Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/events"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-types"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-types{?page,size,sort}",
      "templated" : true
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c94cedfd01c048d03d/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    }
  }
}

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

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

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

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

{
  "id" : "5c3ef0c74cedfd01c048d01b",
  "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/5c3ef0c74cedfd01c048d01b"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d01b"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d01b/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d01b/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/5c3ef1004cedfd01c048d4b4/content-types HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "contentTypeId" : "5c3ef1004cedfd01c048d4b3"
}

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" : "5c3ef1004cedfd01c048d4b4",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ {
    "hubContentTypeId" : "5c3ef1004cedfd01c048d4b3",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
  } ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1004cedfd01c048d4b0"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1004cedfd01c048d4b0/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1004cedfd01c048d4b0/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/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/5c3ef1004cedfd01c048d4b4/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b4/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/5c3ef0ff4cedfd01c048d499/content-types/5c3ef0ff4cedfd01c048d498 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" : "5c3ef0ff4cedfd01c048d499",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d495"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d495/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d495/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/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/5c3ef0ff4cedfd01c048d499/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d499/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/5c3ef0c64cedfd01c048d004/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" : "5c3ef0c64cedfd01c048d007",
      "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/5c3ef0c64cedfd01c048d007"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d007"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d007/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d007/schema"
        }
      }
    }, {
      "id" : "5c3ef0c64cedfd01c048d009",
      "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/5c3ef0c64cedfd01c048d009"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d009"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d009/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d009/schema"
        }
      }
    }, {
      "id" : "5c3ef0c74cedfd01c048d00b",
      "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/5c3ef0c74cedfd01c048d00b"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d00b"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d00b/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d00b/schema"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c64cedfd01c048d004/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c64cedfd01c048d004/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c64cedfd01c048d004/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c64cedfd01c048d004/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/5c3ef0c64cedfd01c048d003 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" : "5c3ef0c64cedfd01c048d003",
  "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/5c3ef0c64cedfd01c048d003"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d003"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d003/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048d003/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/5c3ef0c64cedfd01c048cfff 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/5c3ef0c64cedfd01c048cfff
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1016

{
  "id" : "5c3ef0c64cedfd01c048cfff",
  "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/5c3ef0c64cedfd01c048cfff"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048cfff"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048cfff/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c64cedfd01c048cfff/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/5c3ef0c74cedfd01c048d017/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" : "5c3ef0c74cedfd01c048d014",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "cachedSchema" : {
    "allOf" : [ {
      "$ref" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content"
    } ],
    "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
    "description" : "Example of an inline content nested content type",
    "id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "title" : "Inline content type",
    "type" : "object",
    "definitions" : {
      "mapEntry" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "value" : {
            "type" : "string",
            "title" : "this is a title"
          },
          "key" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "key", "value" ]
      }
    },
    "properties" : {
      "arrayExample" : {
        "type" : "array",
        "title" : "this is a title",
        "items" : {
          "$ref" : "#/definitions/mapEntry"
        }
      },
      "internalRefExample" : {
        "$ref" : "#/definitions/mapEntry"
      },
      "inlineExample" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "field1" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "field1" ]
      },
      "externalRefExample" : {
        "$ref" : "http://deliver.bigcontent.io/schema/empty-type.json#"
      }
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d017/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/5c3ef0c74cedfd01c048d013/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" : "5c3ef0c74cedfd01c048d010",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "cachedSchema" : {
    "allOf" : [ {
      "$ref" : "http://bigcontent.io/cms/schema/v1/core#/definitions/content"
    } ],
    "$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
    "description" : "Example of an inline content nested content type",
    "id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "title" : "Newly Updated title",
    "type" : "object",
    "definitions" : {
      "mapEntry" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "value" : {
            "type" : "string",
            "title" : "this is a title"
          },
          "key" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "key", "value" ]
      }
    },
    "properties" : {
      "arrayExample" : {
        "type" : "array",
        "title" : "this is a title",
        "items" : {
          "$ref" : "#/definitions/mapEntry"
        }
      },
      "internalRefExample" : {
        "$ref" : "#/definitions/mapEntry"
      },
      "inlineExample" : {
        "type" : "object",
        "title" : "this is a title",
        "properties" : {
          "field1" : {
            "type" : "string",
            "title" : "this is a title"
          }
        },
        "required" : [ "field1" ]
      },
      "externalRefExample" : {
        "$ref" : "http://deliver.bigcontent.io/schema/empty-type.json#"
      }
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c3ef0c74cedfd01c048d013/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/5c3ef0c54cedfd01c048cff2/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/5c3ef0c64cedfd01c048cff3
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

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

{
  "id" : "5c3ef0c54cedfd01c048cff1",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c54cedfd01c048cff0"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c54cedfd01c048cff0/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0c54cedfd01c048cff0/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/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/5c3ef0c54cedfd01c048cff1/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c54cedfd01c048cff1/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/5c3ef0ff4cedfd01c048d49e/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/5c3ef0ff4cedfd01c048d4a2/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/5c3ef0ff4cedfd01c048d49a/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" : "5c3ef0ff4cedfd01c048d49c",
      "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/5c3ef0ff4cedfd01c048d49c"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/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/5c3ef0ff4cedfd01c048d49c/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d49c/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d49a/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/5c3ef0c54cedfd01c048cfef/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/5c3ef0c34cedfd01c048cfc4/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 326

{
  "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" : "5c3ef0c34cedfd01c048cfc8"
}

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: Wed, 16 Jan 2019 08:52:19 GMT
Location: https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "4c9d888e-8888-4ddb-aeb4-df7561a9ec97",
  "folderId" : "5c3ef0c34cedfd01c048cfc8",
  "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-01-16T08:52:19.923Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:19.923Z",
  "deliveryId" : "4c9d888e-8888-4ddb-aeb4-df7561a9ec97",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c34cedfd01c048cfc4"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4c9d888e-8888-4ddb-aeb4-df7561a9ec97",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c3ef0c34cedfd01c048cfc8"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4c9d888e-8888-4ddb-aeb4-df7561a9ec97{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4c9d888e-8888-4ddb-aeb4-df7561a9ec97/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4c9d888e-8888-4ddb-aeb4-df7561a9ec97"
    }
  }
}

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/fb908a81-2270-4fa2-9267-d10b12f0e56b 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: Wed, 16 Jan 2019 08:52:19 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3761

{
  "id" : "fb908a81-2270-4fa2-9267-d10b12f0e56b",
  "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-01-16T08:52:19.562Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:19.562Z",
  "deliveryId" : "fb908a81-2270-4fa2-9267-d10b12f0e56b",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c34cedfd01c048cfbe"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fb908a81-2270-4fa2-9267-d10b12f0e56b",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fb908a81-2270-4fa2-9267-d10b12f0e56b{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fb908a81-2270-4fa2-9267-d10b12f0e56b/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fb908a81-2270-4fa2-9267-d10b12f0e56b"
    }
  }
}

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/0438f273-e0cf-454b-b221-5f853bd177d4 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" : "5c3ef0c44cedfd01c048cfcf"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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: Wed, 16 Jan 2019 08:52:20 GMT
Location: https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3920

{
  "id" : "0438f273-e0cf-454b-b221-5f853bd177d4",
  "folderId" : "5c3ef0c44cedfd01c048cfcf",
  "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-01-16T08:52:20.172Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:20.213Z",
  "deliveryId" : "0438f273-e0cf-454b-b221-5f853bd177d4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfcb"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0438f273-e0cf-454b-b221-5f853bd177d4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c3ef0c44cedfd01c048cfcf"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0438f273-e0cf-454b-b221-5f853bd177d4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0438f273-e0cf-454b-b221-5f853bd177d4/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0438f273-e0cf-454b-b221-5f853bd177d4"
    }
  }
}

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/5c3ef0cc4cedfd01c048d067/content-items?sourceContentItemId=a21cd45f-0b94-4e59-a768-43123fc1f04c 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: Wed, 16 Jan 2019 08:52:28 GMT
Location: https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3749

{
  "id" : "2075ed26-35da-40b3-9907-fd6f22435c6c",
  "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-01-16T08:52:28.558Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:28.558Z",
  "deliveryId" : "2075ed26-35da-40b3-9907-fd6f22435c6c",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cc4cedfd01c048d067"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2075ed26-35da-40b3-9907-fd6f22435c6c",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2075ed26-35da-40b3-9907-fd6f22435c6c{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2075ed26-35da-40b3-9907-fd6f22435c6c/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2075ed26-35da-40b3-9907-fd6f22435c6c"
    }
  }
}

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/5c3ef0cc4cedfd01c048d06e/content-items?sourceContentItemId=e94b8225-64bb-4bf7-b93a-0b6efd99893b 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" : "5c3ef0cc4cedfd01c048d074"
}

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: Wed, 16 Jan 2019 08:52:28 GMT
Location: https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3882

{
  "id" : "4b2cf3aa-b394-47e9-b34a-fc850a548de2",
  "folderId" : "5c3ef0cc4cedfd01c048d074",
  "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-01-16T08:52:28.878Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:28.878Z",
  "deliveryId" : "4b2cf3aa-b394-47e9-b34a-fc850a548de2",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cc4cedfd01c048d06e"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4b2cf3aa-b394-47e9-b34a-fc850a548de2",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c3ef0cc4cedfd01c048d074"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4b2cf3aa-b394-47e9-b34a-fc850a548de2{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b2cf3aa-b394-47e9-b34a-fc850a548de2/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4b2cf3aa-b394-47e9-b34a-fc850a548de2"
    }
  }
}

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/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/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: 3763

{
  "id" : "fe5c194f-1c4c-46b8-99b0-b3063e9d50ff",
  "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-01-16T08:53:18.874Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:53:18.893Z",
  "deliveryId" : "fe5c194f-1c4c-46b8-99b0-b3063e9d50ff",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d446"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fe5c194f-1c4c-46b8-99b0-b3063e9d50ff",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fe5c194f-1c4c-46b8-99b0-b3063e9d50ff{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fe5c194f-1c4c-46b8-99b0-b3063e9d50ff/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fe5c194f-1c4c-46b8-99b0-b3063e9d50ff"
    }
  }
}

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/fdb9c987-6714-4c09-b678-ec932958aa53/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: 3761

{
  "id" : "fdb9c987-6714-4c09-b678-ec932958aa53",
  "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" : "fdb9c987-6714-4c09-b678-ec932958aa53",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d43e"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fdb9c987-6714-4c09-b678-ec932958aa53",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fdb9c987-6714-4c09-b678-ec932958aa53{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fdb9c987-6714-4c09-b678-ec932958aa53/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fdb9c987-6714-4c09-b678-ec932958aa53"
    }
  }
}

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" : "5c3ef0c54cedfd01c048cfe7",
  "id" : "46a82b5b-f502-442f-b2fd-35407d3364f6"
}, {
  "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" : "5c3ef0c54cedfd01c048cfe7",
  "id" : "44c475eb-7ded-4db9-9af8-75c34175de32"
} ]

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" : "46a82b5b-f502-442f-b2fd-35407d3364f6",
    "status" : 200,
    "description" : null
  }, {
    "id" : "44c475eb-7ded-4db9-9af8-75c34175de32",
    "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/5c3ef0c44cedfd01c048cfd3/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: 13484

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "fd915cf1-4e73-4aad-af11-65bf517cc727",
      "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-01-16T08:52:20.499Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.499Z",
      "deliveryId" : "fd915cf1-4e73-4aad-af11-65bf517cc727",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fd915cf1-4e73-4aad-af11-65bf517cc727",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fd915cf1-4e73-4aad-af11-65bf517cc727{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd915cf1-4e73-4aad-af11-65bf517cc727/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fd915cf1-4e73-4aad-af11-65bf517cc727"
        }
      }
    }, {
      "id" : "0029a2a8-2e4a-4913-92a3-794b5b1211d9",
      "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-01-16T08:52:20.463Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.463Z",
      "deliveryId" : "0029a2a8-2e4a-4913-92a3-794b5b1211d9",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0029a2a8-2e4a-4913-92a3-794b5b1211d9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0029a2a8-2e4a-4913-92a3-794b5b1211d9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0029a2a8-2e4a-4913-92a3-794b5b1211d9/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0029a2a8-2e4a-4913-92a3-794b5b1211d9"
        }
      }
    }, {
      "id" : "d428e50e-d81f-4db6-ad40-1769c34d6601",
      "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-01-16T08:52:20.425Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.425Z",
      "deliveryId" : "d428e50e-d81f-4db6-ad40-1769c34d6601",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d428e50e-d81f-4db6-ad40-1769c34d6601",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d428e50e-d81f-4db6-ad40-1769c34d6601{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d428e50e-d81f-4db6-ad40-1769c34d6601/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d428e50e-d81f-4db6-ad40-1769c34d6601"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfd3/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/5c3ef0cb4cedfd01c048d050/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: 4815

{
  "_embedded" : {
    "content-items" : [ {
      "createdBy" : "user",
      "label" : "Banner Ad Homepage",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "deliveryId" : "708d5f75-06b3-483c-8e8b-de83115b87a4",
      "folderId" : null,
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "locale" : "en",
      "version" : 1,
      "status" : "ACTIVE",
      "id" : "708d5f75-06b3-483c-8e8b-de83115b87a4",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cb4cedfd01c048d050"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=708d5f75-06b3-483c-8e8b-de83115b87a4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=708d5f75-06b3-483c-8e8b-de83115b87a4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/708d5f75-06b3-483c-8e8b-de83115b87a4/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=708d5f75-06b3-483c-8e8b-de83115b87a4"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cb4cedfd01c048d050/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cb4cedfd01c048d050/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cb4cedfd01c048d050/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cb4cedfd01c048d050/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/5c3ef0c44cedfd01c048cfdb/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: 13435

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "2a8019fb-c771-4f43-929e-c304c2ed590a",
      "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-01-16T08:52:20.760Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.760Z",
      "deliveryId" : "2a8019fb-c771-4f43-929e-c304c2ed590a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2a8019fb-c771-4f43-929e-c304c2ed590a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2a8019fb-c771-4f43-929e-c304c2ed590a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2a8019fb-c771-4f43-929e-c304c2ed590a/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2a8019fb-c771-4f43-929e-c304c2ed590a"
        }
      }
    }, {
      "id" : "bf11bfa0-54f5-4100-924b-cae34ba24d3a",
      "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-01-16T08:52:20.795Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.795Z",
      "deliveryId" : "bf11bfa0-54f5-4100-924b-cae34ba24d3a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bf11bfa0-54f5-4100-924b-cae34ba24d3a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bf11bfa0-54f5-4100-924b-cae34ba24d3a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bf11bfa0-54f5-4100-924b-cae34ba24d3a/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bf11bfa0-54f5-4100-924b-cae34ba24d3a"
        }
      }
    }, {
      "id" : "32152b1a-5bbb-4474-941a-3c8f3c904a2d",
      "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-01-16T08:52:20.834Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:20.834Z",
      "deliveryId" : "32152b1a-5bbb-4474-941a-3c8f3c904a2d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=32152b1a-5bbb-4474-941a-3c8f3c904a2d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=32152b1a-5bbb-4474-941a-3c8f3c904a2d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/32152b1a-5bbb-4474-941a-3c8f3c904a2d/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=32152b1a-5bbb-4474-941a-3c8f3c904a2d"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c44cedfd01c048cfdb/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/5c3ef0fd4cedfd01c048d41a/content-items?folderId=5c3ef0fd4cedfd01c048d41e 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: 5187

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "15eccb5b-4ce0-4338-add9-5903ea8d5a4d",
      "folderId" : "5c3ef0fd4cedfd01c048d41e",
      "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-01-16T08:53:17.926Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:17.926Z",
      "deliveryId" : "15eccb5b-4ce0-4338-add9-5903ea8d5a4d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d41a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=15eccb5b-4ce0-4338-add9-5903ea8d5a4d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fd4cedfd01c048d41e"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=15eccb5b-4ce0-4338-add9-5903ea8d5a4d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/15eccb5b-4ce0-4338-add9-5903ea8d5a4d/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=15eccb5b-4ce0-4338-add9-5903ea8d5a4d"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d41a/content-items?folderId=5c3ef0fd4cedfd01c048d41e&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d41a/content-items?folderId=5c3ef0fd4cedfd01c048d41e&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d41a/content-items?folderId=5c3ef0fd4cedfd01c048d41e&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d41a/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/5c3ef0fd4cedfd01c048d40e/content-items?folderId=5c3ef0fd4cedfd01c048d412,5c3ef0fd4cedfd01c048d413 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: 18018

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "fe793672-b041-4dca-9ee4-8038d3f3ccaa",
      "folderId" : "5c3ef0fd4cedfd01c048d413",
      "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-01-16T08:53:17.737Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:17.737Z",
      "deliveryId" : "fe793672-b041-4dca-9ee4-8038d3f3ccaa",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fe793672-b041-4dca-9ee4-8038d3f3ccaa",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fd4cedfd01c048d413"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fe793672-b041-4dca-9ee4-8038d3f3ccaa{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fe793672-b041-4dca-9ee4-8038d3f3ccaa/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fe793672-b041-4dca-9ee4-8038d3f3ccaa"
        }
      }
    }, {
      "id" : "55b058f7-bc76-44bd-93b5-c75dd0e34427",
      "folderId" : "5c3ef0fd4cedfd01c048d413",
      "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-01-16T08:53:17.720Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:17.720Z",
      "deliveryId" : "55b058f7-bc76-44bd-93b5-c75dd0e34427",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=55b058f7-bc76-44bd-93b5-c75dd0e34427",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fd4cedfd01c048d413"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=55b058f7-bc76-44bd-93b5-c75dd0e34427{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/55b058f7-bc76-44bd-93b5-c75dd0e34427/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=55b058f7-bc76-44bd-93b5-c75dd0e34427"
        }
      }
    }, {
      "id" : "c55f8762-1c62-4b34-b46a-92c44e1b0c8b",
      "folderId" : "5c3ef0fd4cedfd01c048d413",
      "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-01-16T08:53:17.703Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:17.703Z",
      "deliveryId" : "c55f8762-1c62-4b34-b46a-92c44e1b0c8b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c55f8762-1c62-4b34-b46a-92c44e1b0c8b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fd4cedfd01c048d413"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c55f8762-1c62-4b34-b46a-92c44e1b0c8b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c55f8762-1c62-4b34-b46a-92c44e1b0c8b/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c55f8762-1c62-4b34-b46a-92c44e1b0c8b"
        }
      }
    }, {
      "id" : "ef0dede7-979c-4628-a602-a87cfa1c938a",
      "folderId" : "5c3ef0fd4cedfd01c048d412",
      "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-01-16T08:53:17.686Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:17.686Z",
      "deliveryId" : "ef0dede7-979c-4628-a602-a87cfa1c938a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ef0dede7-979c-4628-a602-a87cfa1c938a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fd4cedfd01c048d412"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ef0dede7-979c-4628-a602-a87cfa1c938a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef0dede7-979c-4628-a602-a87cfa1c938a/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ef0dede7-979c-4628-a602-a87cfa1c938a"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e/content-items?folderId=5c3ef0fd4cedfd01c048d412,5c3ef0fd4cedfd01c048d413&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e/content-items?folderId=5c3ef0fd4cedfd01c048d412,5c3ef0fd4cedfd01c048d413&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e/content-items?folderId=5c3ef0fd4cedfd01c048d412,5c3ef0fd4cedfd01c048d413&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d40e/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/5c3ef0fe4cedfd01c048d426/content-items?folderId=5c3ef0fe4cedfd01c048d42a&folderId=5c3ef0fe4cedfd01c048d42b 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: 18045

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64",
      "folderId" : "5c3ef0fe4cedfd01c048d42b",
      "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-01-16T08:53:18.191Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.191Z",
      "deliveryId" : "dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d42b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=dd8c1b7a-219a-4f13-bf15-e37a7f1a0a64"
        }
      }
    }, {
      "id" : "a31bc31c-3729-420b-8e39-561ba911218d",
      "folderId" : "5c3ef0fe4cedfd01c048d42b",
      "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-01-16T08:53:18.173Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.173Z",
      "deliveryId" : "a31bc31c-3729-420b-8e39-561ba911218d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a31bc31c-3729-420b-8e39-561ba911218d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d42b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a31bc31c-3729-420b-8e39-561ba911218d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a31bc31c-3729-420b-8e39-561ba911218d/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a31bc31c-3729-420b-8e39-561ba911218d"
        }
      }
    }, {
      "id" : "c421ed86-3ee2-497b-9220-1c074a7eb91f",
      "folderId" : "5c3ef0fe4cedfd01c048d42b",
      "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-01-16T08:53:18.154Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.154Z",
      "deliveryId" : "c421ed86-3ee2-497b-9220-1c074a7eb91f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c421ed86-3ee2-497b-9220-1c074a7eb91f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d42b"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c421ed86-3ee2-497b-9220-1c074a7eb91f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c421ed86-3ee2-497b-9220-1c074a7eb91f/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c421ed86-3ee2-497b-9220-1c074a7eb91f"
        }
      }
    }, {
      "id" : "72fce680-94c7-4a59-b7d2-ee3ac5c137d0",
      "folderId" : "5c3ef0fe4cedfd01c048d42a",
      "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-01-16T08:53:18.135Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.135Z",
      "deliveryId" : "72fce680-94c7-4a59-b7d2-ee3ac5c137d0",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=72fce680-94c7-4a59-b7d2-ee3ac5c137d0",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d42a"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=72fce680-94c7-4a59-b7d2-ee3ac5c137d0{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/72fce680-94c7-4a59-b7d2-ee3ac5c137d0/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=72fce680-94c7-4a59-b7d2-ee3ac5c137d0"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426/content-items?folderId=5c3ef0fe4cedfd01c048d42a&folderId=5c3ef0fe4cedfd01c048d42b&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426/content-items?folderId=5c3ef0fe4cedfd01c048d42a&folderId=5c3ef0fe4cedfd01c048d42b&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426/content-items?folderId=5c3ef0fe4cedfd01c048d42a&folderId=5c3ef0fe4cedfd01c048d42b&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d426/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/5c3ef0fe4cedfd01c048d432/content-items?folderId=!5c3ef0fe4cedfd01c048d436 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: 17800

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "3734ad67-4c87-43be-8c25-dab96e732e37",
      "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-01-16T08:53:18.454Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.454Z",
      "deliveryId" : "3734ad67-4c87-43be-8c25-dab96e732e37",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3734ad67-4c87-43be-8c25-dab96e732e37",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3734ad67-4c87-43be-8c25-dab96e732e37{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3734ad67-4c87-43be-8c25-dab96e732e37/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3734ad67-4c87-43be-8c25-dab96e732e37"
        }
      }
    }, {
      "id" : "ebe2aed9-cfd5-4709-b217-b362447fd172",
      "folderId" : "5c3ef0fe4cedfd01c048d437",
      "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-01-16T08:53:18.429Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.429Z",
      "deliveryId" : "ebe2aed9-cfd5-4709-b217-b362447fd172",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ebe2aed9-cfd5-4709-b217-b362447fd172",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d437"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ebe2aed9-cfd5-4709-b217-b362447fd172{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ebe2aed9-cfd5-4709-b217-b362447fd172/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ebe2aed9-cfd5-4709-b217-b362447fd172"
        }
      }
    }, {
      "id" : "e600a857-d277-45f7-be00-04ceca21b243",
      "folderId" : "5c3ef0fe4cedfd01c048d437",
      "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-01-16T08:53:18.404Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.404Z",
      "deliveryId" : "e600a857-d277-45f7-be00-04ceca21b243",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e600a857-d277-45f7-be00-04ceca21b243",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d437"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e600a857-d277-45f7-be00-04ceca21b243{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e600a857-d277-45f7-be00-04ceca21b243/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e600a857-d277-45f7-be00-04ceca21b243"
        }
      }
    }, {
      "id" : "a2e8124a-3d84-4abe-81dc-513eb15b1ffe",
      "folderId" : "5c3ef0fe4cedfd01c048d437",
      "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-01-16T08:53:18.377Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:18.377Z",
      "deliveryId" : "a2e8124a-3d84-4abe-81dc-513eb15b1ffe",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a2e8124a-3d84-4abe-81dc-513eb15b1ffe",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c3ef0fe4cedfd01c048d437"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a2e8124a-3d84-4abe-81dc-513eb15b1ffe{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2e8124a-3d84-4abe-81dc-513eb15b1ffe/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a2e8124a-3d84-4abe-81dc-513eb15b1ffe"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432/content-items?folderId=!5c3ef0fe4cedfd01c048d436&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432/content-items?folderId=!5c3ef0fe4cedfd01c048d436&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432/content-items?folderId=!5c3ef0fe4cedfd01c048d436&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fe4cedfd01c048d432/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/bc74405a-0d11-4bd3-b408-b334e39ff132/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-01-16T08:53:20.859Z",
        "historyEventId" : "23609274-d196-44a2-8ee1-25c4864845fe"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "f053f091-0c18-4dba-8a4d-2ea750cc5e2d",
        "createdDate" : "2019-01-06T08:53:20.870Z",
        "historyEventId" : "fe69acb3-0501-4f60-83b3-b214deb7e1e3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "040bffd2-8469-413a-bc14-9054983c9e3f",
        "createdDate" : "2019-01-05T08:53:20.870Z",
        "historyEventId" : "df911220-9b6f-45d3-a72f-fcd07bcb577b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "61e8ad7f-7d54-4d6d-9422-20fecb625d1c",
        "createdDate" : "2019-01-04T08:53:20.870Z",
        "historyEventId" : "5c687ba8-bc7d-48a7-b4b7-02a11cd7a813"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "00174260-54a9-4c92-b52e-84e51a251ac3",
        "createdDate" : "2019-01-03T08:53:20.870Z",
        "historyEventId" : "baa2d28c-05be-4862-9087-17762b734433"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "f8624c82-1e87-41b0-9d7e-5d128c1e5996",
        "createdDate" : "2019-01-02T08:53:20.870Z",
        "historyEventId" : "071c9c76-7d57-44bd-8237-7841b7fbb126"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.862Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.826Z",
        "historyEventId" : "c4363480-f218-4bfc-8300-18351b07c726"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "46871cb7-90e0-43d9-a058-8aa71e141bb1",
        "createdDate" : "2019-01-05T08:53:20.870Z",
        "historyEventId" : "ca4e0e45-f908-4851-8386-6931c714f437"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "57b5a90c-c059-4730-983a-2998104cbbfc",
        "createdDate" : "2019-01-04T08:53:20.870Z",
        "historyEventId" : "627c923b-916b-4dce-9ca8-969b2dad4d02"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c91fb633-49dd-4e94-b953-35b1246a47bd",
        "createdDate" : "2019-01-03T08:53:20.870Z",
        "historyEventId" : "18320bb9-b2c3-4dd4-af6e-054563e47bbd"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "0a4bf853-36ab-4c00-a00e-9229c18370ea",
        "createdDate" : "2019-01-02T08:53:20.870Z",
        "historyEventId" : "9253cdba-dd77-4839-a6c6-e70792acae78"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b2e016b5-0ed5-438c-b5c2-34a3446a561e",
        "createdDate" : "2019-01-01T08:53:20.870Z",
        "historyEventId" : "a5f2c5f3-3376-41a2-8aba-44f7ce92e458"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.829Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.794Z",
        "historyEventId" : "c2e62a64-43d6-4919-9ef7-4c08e7481d28"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5c0f2b86-57dd-48bb-86b6-a7a6553bd912",
        "createdDate" : "2019-01-04T08:53:20.870Z",
        "historyEventId" : "6db1da72-d4ff-491a-aa6e-33aeb67cff19"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5935dd76-e77d-445a-9b3c-28198c45875a",
        "createdDate" : "2019-01-03T08:53:20.870Z",
        "historyEventId" : "c2702345-878d-4a70-b271-7f50e6e61de3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1b0b2f47-40ae-4648-a226-abcab67e8825",
        "createdDate" : "2019-01-02T08:53:20.870Z",
        "historyEventId" : "bba099fc-07dd-42f7-82cd-6c5c4fbc05fd"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "99a2da89-30c9-41b8-a695-4dca02fcff1c",
        "createdDate" : "2019-01-01T08:53:20.870Z",
        "historyEventId" : "865a4770-f1cc-4cf6-b41b-8f5b4b6e8cd7"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "75df0ff7-45cb-4b05-a955-152ef331a18b",
        "createdDate" : "2018-12-31T08:53:20.870Z",
        "historyEventId" : "094c87bc-c486-451c-a065-348ef52bc45d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.797Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.760Z",
        "historyEventId" : "132cabb4-a920-41dd-b78b-2f1ba36c2872"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6a33d44f-b6e9-482b-b2b5-2b3f26f5602e",
        "createdDate" : "2019-01-03T08:53:20.870Z",
        "historyEventId" : "9d949a24-8578-4ae7-8342-d36458e5ed7a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "942bd6e8-ad50-409e-a13b-378b01f13766",
        "createdDate" : "2019-01-02T08:53:20.870Z",
        "historyEventId" : "0c07321c-f595-48b7-8597-5e361ee948ab"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "e1fd3e78-8e19-454a-b150-f11d4ca9a52a",
        "createdDate" : "2019-01-01T08:53:20.870Z",
        "historyEventId" : "52d31d8b-27ec-49ca-a125-55a44ff484de"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "3a230273-ebee-4934-80ea-64b2094dcf05",
        "createdDate" : "2018-12-31T08:53:20.870Z",
        "historyEventId" : "910dc067-33d1-4d14-83aa-41869e3d8932"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "64ca25d2-0d33-4fbe-ac3a-8436cbc111eb",
        "createdDate" : "2018-12-30T08:53:20.870Z",
        "historyEventId" : "725a2279-079f-4cc8-b146-9ba38635d818"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.763Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.726Z",
        "historyEventId" : "f5caa790-0553-442f-ae43-2d219c70855a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "e4f053e6-bafd-4a66-b75d-3a36084f991f",
        "createdDate" : "2019-01-02T08:53:20.870Z",
        "historyEventId" : "3eb4dd80-094d-4277-87ad-181e3c165066"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "95f19912-e7ae-4121-8868-df05c8a1b5a5",
        "createdDate" : "2019-01-01T08:53:20.870Z",
        "historyEventId" : "f4434eac-2c30-45b7-a922-9bcd2b8fea0b"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "11b72884-99e2-4b30-9826-21b1018a43d3",
        "createdDate" : "2018-12-31T08:53:20.870Z",
        "historyEventId" : "b9dc8233-e019-4c61-94e0-7a3f2dc3881f"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "28691e49-872c-4ca8-9001-9d48c3def53d",
        "createdDate" : "2018-12-30T08:53:20.870Z",
        "historyEventId" : "d8628a1d-385b-44ad-bb24-a8da42fb06bd"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "10a7a737-9f84-4552-91f1-d358cf51e769",
        "createdDate" : "2018-12-29T08:53:20.870Z",
        "historyEventId" : "eeddbdab-6e24-4409-a35f-57dd46f882be"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.729Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.695Z",
        "historyEventId" : "003f1b2d-5212-4e4b-80a8-9562bc1b81ab"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "32650dc5-a0b6-46f0-9303-5bba6b1893f9",
        "createdDate" : "2019-01-01T08:53:20.870Z",
        "historyEventId" : "3bb847e6-0ca8-4c16-acb7-e43a0f7fe11d"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "4820bf12-7efd-4abb-9cfa-d78932b76675",
        "createdDate" : "2018-12-31T08:53:20.870Z",
        "historyEventId" : "3105afb7-3ffd-411f-aff3-6016878c4d5f"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "6c12b521-9a2a-411e-8e8f-485513af3c73",
        "createdDate" : "2018-12-30T08:53:20.870Z",
        "historyEventId" : "8bc69be1-75bd-4d87-92fc-1d0779ee2d98"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "73d20ca5-08da-4e61-9960-d71b4edabf71",
        "createdDate" : "2018-12-29T08:53:20.870Z",
        "historyEventId" : "6b08612f-5052-4eee-97c5-0944ff43257b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "60e34a1a-44db-4f3d-aae3-5f31490d32de",
        "createdDate" : "2018-12-28T08:53:20.870Z",
        "historyEventId" : "877e561d-f626-4f2d-b2fc-714a69cf0cc1"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.698Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.663Z",
        "historyEventId" : "13c2a904-81b7-4a49-a319-257cb5cf2447"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "cb43a7e3-f3e3-4628-8bdb-31ef18ce081b",
        "createdDate" : "2018-12-31T08:53:20.870Z",
        "historyEventId" : "f190b521-139b-4eb3-b344-ec08c60927fe"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "f87026c5-3f14-4fc1-8e5c-5d1a628bbbbf",
        "createdDate" : "2018-12-30T08:53:20.870Z",
        "historyEventId" : "c255f7c6-faf1-4fdc-b97d-53c3ba99e0f0"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "0e9fecda-fb94-4d4f-8ac5-3175285bfe99",
        "createdDate" : "2018-12-29T08:53:20.870Z",
        "historyEventId" : "c5b587b8-5348-472b-a81a-eaf4b1507bd0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6a12fcae-e00c-47d1-a20b-d5d7d1182363",
        "createdDate" : "2018-12-28T08:53:20.870Z",
        "historyEventId" : "740f757c-25b9-4031-98b8-f2b1cb84b294"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.666Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.632Z",
        "historyEventId" : "1302056d-6ec1-4a1b-816c-94b5da25e4eb"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "a952586d-1b62-4331-9775-0a84c0f85c94",
        "createdDate" : "2018-12-30T08:53:20.870Z",
        "historyEventId" : "113ce637-945e-407a-996d-4c1f9fe64155"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "04dc4ffb-22b0-4c7c-9245-df8cc150e724",
        "createdDate" : "2018-12-29T08:53:20.870Z",
        "historyEventId" : "f7fb270e-772a-4d26-8535-13ab5cd93be1"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9024dbbc-aabc-4598-908c-3d8fd15b4de3",
        "createdDate" : "2018-12-28T08:53:20.870Z",
        "historyEventId" : "c4b4524f-89f7-45e7-9198-5e915eba5185"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.635Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.598Z",
        "historyEventId" : "3ea36cf7-6433-478d-8d7b-1f29d3699851"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "6c7c78dd-1261-4519-8c54-f5bc9c654460",
        "createdDate" : "2018-12-29T08:53:20.870Z",
        "historyEventId" : "82c954ac-842b-494e-91a4-0bbf12e1ff49"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ad50d0cc-63c6-4a3d-b7a3-2977780bc6d2",
        "createdDate" : "2018-12-28T08:53:20.870Z",
        "historyEventId" : "4dd2b42d-8a5c-47b6-9b9b-d29fe636696c"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.601Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:20.567Z",
        "historyEventId" : "832cea75-0673-4316-8794-6d4882c12f17"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9ab89893-45b2-4c66-9284-1afa7e413753",
        "createdDate" : "2018-12-28T08:53:20.870Z",
        "historyEventId" : "4bc03108-8e86-47fc-b5e2-7fc28c98b566"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:20.569Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc74405a-0d11-4bd3-b408-b334e39ff132/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/e378e742-3a46-4ffb-b865-396b4d73812a/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" : "b12587e9-778d-4825-b04e-d71783e5167f",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-16T08:53:19.059Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "ab39669d-6c83-4030-8186-0d56231287c2",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-12T08:53:19.069Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "2b02b3a7-a8bd-4615-ae8d-fee1eb2e8848",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-11T08:53:19.069Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "fec8a3e4-f846-4090-92e5-96589f047ce4",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-10T08:53:19.069Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "29cb180a-2eb3-4cf4-ad87-3b5da756309f",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-09T08:53:19.069Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "6f070f47-6bc8-40bd-aa1d-337087db47b6",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-08T08:53:19.069Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "11add244-3e73-4e5e-86b1-0c529516e995",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-07T08:53:19.069Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "f738dbc6-79ce-478e-8364-ff27cf191695",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-06T08:53:19.069Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "29c3d1e7-1316-4b68-9a90-96727785ceff",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-05T08:53:19.069Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "fa009c77-83b5-4ab5-912c-1cf8f013d201",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-04T08:53:19.069Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "8d7d64fe-c5e9-4448-973e-dd4ef47f9d56",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-03T08:53:19.069Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "2d0f8734-8142-4737-93d0-731816572bc8",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-02T08:53:19.069Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "e09cf2b9-d5cf-4ef6-ac6a-ed9c6d9bc73c",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2019-01-01T08:53:19.069Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "4c31fa07-d9c3-4668-b6d1-f4ddffcd757a",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2018-12-31T08:53:19.069Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "660b0ce0-26cf-48ae-909f-6888d840c8a9",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2018-12-30T08:53:19.069Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "4c74205c-f6cd-4a46-90d5-d0db3f3beda0",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2018-12-29T08:53:19.069Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "4199b8b9-c152-4124-a67e-62a6c3d11ac7",
      "contentItemId" : "e378e742-3a46-4ffb-b865-396b4d73812a",
      "version" : 1,
      "createdDate" : "2018-12-28T08:53:19.069Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e378e742-3a46-4ffb-b865-396b4d73812a/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e378e742-3a46-4ffb-b865-396b4d73812a/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/e378e742-3a46-4ffb-b865-396b4d73812a/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/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/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" : "b39f4c25-5510-4c24-8a2c-00d96d82c7b1",
      "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-01-16T08:53:20.372Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:20.405Z",
      "deliveryId" : "b39f4c25-5510-4c24-8a2c-00d96d82c7b1",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b6"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b39f4c25-5510-4c24-8a2c-00d96d82c7b1"
        }
      }
    }, {
      "id" : "b39f4c25-5510-4c24-8a2c-00d96d82c7b1",
      "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-01-16T08:53:20.372Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:20.405Z",
      "deliveryId" : "b39f4c25-5510-4c24-8a2c-00d96d82c7b1",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef1004cedfd01c048d4b6"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b39f4c25-5510-4c24-8a2c-00d96d82c7b1"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b39f4c25-5510-4c24-8a2c-00d96d82c7b1/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=23210843-e304-4694-9880-c4931be99854 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: 13443

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "23210843-e304-4694-9880-c4931be99854",
      "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" : "d4356d44-005e-4d99-856d-ce5df12b00a5"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:52:19.209Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:19.209Z",
      "deliveryId" : "23210843-e304-4694-9880-c4931be99854",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c34cedfd01c048cfb9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=23210843-e304-4694-9880-c4931be99854",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=23210843-e304-4694-9880-c4931be99854{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854/edition-slot-associations"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=23210843-e304-4694-9880-c4931be99854"
        }
      }
    }, {
      "id" : "d4356d44-005e-4d99-856d-ce5df12b00a5",
      "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" : "f7e6ffbe-e305-460a-a03a-2f227bad7ea7"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:52:19.168Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:19.168Z",
      "deliveryId" : "d4356d44-005e-4d99-856d-ce5df12b00a5",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c34cedfd01c048cfb9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d4356d44-005e-4d99-856d-ce5df12b00a5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d4356d44-005e-4d99-856d-ce5df12b00a5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d4356d44-005e-4d99-856d-ce5df12b00a5/edition-slot-associations"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d4356d44-005e-4d99-856d-ce5df12b00a5"
        }
      }
    }, {
      "id" : "f7e6ffbe-e305-460a-a03a-2f227bad7ea7",
      "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-01-16T08:52:19.129Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:52:19.129Z",
      "deliveryId" : "f7e6ffbe-e305-460a-a03a-2f227bad7ea7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/planned{?epoch,time}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c34cedfd01c048cfb9"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f7e6ffbe-e305-460a-a03a-2f227bad7ea7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f7e6ffbe-e305-460a-a03a-2f227bad7ea7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7e6ffbe-e305-460a-a03a-2f227bad7ea7/edition-slot-associations"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f7e6ffbe-e305-460a-a03a-2f227bad7ea7"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=23210843-e304-4694-9880-c4931be99854"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23210843-e304-4694-9880-c4931be99854{?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/05fe58a5-2347-408b-a6b7-331a4c1440f7/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" : "05fe58a5-2347-408b-a6b7-331a4c1440f7",
  "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-01-16T08:52:17.874Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:17.874Z",
  "deliveryId" : "05fe58a5-2347-408b-a6b7-331a4c1440f7",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/05fe58a5-2347-408b-a6b7-331a4c1440f7/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c14cedfd01c048cfa2"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=05fe58a5-2347-408b-a6b7-331a4c1440f7"
    }
  }
}

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/22a5fa76-57d6-4b84-975f-ec49f17d74d8/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" : "22a5fa76-57d6-4b84-975f-ec49f17d74d8",
  "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-01-16T08:52:16.878Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:17.297Z",
  "deliveryId" : "22a5fa76-57d6-4b84-975f-ec49f17d74d8",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/22a5fa76-57d6-4b84-975f-ec49f17d74d8/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c04cedfd01c048cf99"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=22a5fa76-57d6-4b84-975f-ec49f17d74d8"
    }
  }
}

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/d53912d9-ee37-4f92-a450-0120d9af4cbc/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" : "d53912d9-ee37-4f92-a450-0120d9af4cbc",
  "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-01-16T08:52:18.275Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:18.428Z",
  "deliveryId" : "d53912d9-ee37-4f92-a450-0120d9af4cbc",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d53912d9-ee37-4f92-a450-0120d9af4cbc/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0c24cedfd01c048cfa9"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d53912d9-ee37-4f92-a450-0120d9af4cbc"
    }
  }
}

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/5fc82770-8617-49a6-ab52-4aa27563f141/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: Wed, 16 Jan 2019 08:53:17 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3761

{
  "id" : "5fc82770-8617-49a6-ab52-4aa27563f141",
  "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-01-16T08:53:17.281Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:53:17.354Z",
  "deliveryId" : "5fc82770-8617-49a6-ab52-4aa27563f141",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fd4cedfd01c048d3fc"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5fc82770-8617-49a6-ab52-4aa27563f141",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5fc82770-8617-49a6-ab52-4aa27563f141{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5fc82770-8617-49a6-ab52-4aa27563f141/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5fc82770-8617-49a6-ab52-4aa27563f141"
    }
  }
}

Search Content Items by Text

Text is the default search field.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5c3ef0fc4cedfd01c048d3f4/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: 4402

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "77d3de89-9749-4921-9cef-a6fa03564f36",
      "contentRepositoryId" : "5c3ef0fc4cedfd01c048d3f5",
      "folderId" : null,
      "deliveryId" : "77d3de89-9749-4921-9cef-a6fa03564f36",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:16.899Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:16.899Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0fc4cedfd01c048d3f5"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=77d3de89-9749-4921-9cef-a6fa03564f36",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=77d3de89-9749-4921-9cef-a6fa03564f36{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/77d3de89-9749-4921-9cef-a6fa03564f36/edition-slot-associations"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0fc4cedfd01c048d3f4/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0fc4cedfd01c048d3f4/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0fc4cedfd01c048d3f4/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.

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5c3ef0d34cedfd01c048d08a/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: 77044

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "f8a583a2-f9bf-449d-9ea0-48775fe2f61b",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "f8a583a2-f9bf-449d-9ea0-48775fe2f61b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3e05029c-1fa9-44df-9fd6-aef6f44a1ea6",
      "createdBy" : "user",
      "createdDate" : "2018-12-18T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-18T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f8a583a2-f9bf-449d-9ea0-48775fe2f61b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f8a583a2-f9bf-449d-9ea0-48775fe2f61b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f8a583a2-f9bf-449d-9ea0-48775fe2f61b/edition-slot-associations"
        }
      }
    }, {
      "id" : "57ccd72a-0e17-4440-bc5f-86aa25bd3e3c",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "57ccd72a-0e17-4440-bc5f-86aa25bd3e3c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7ea1f278-096e-406d-9a3c-507f289152dd",
      "createdBy" : "user",
      "createdDate" : "2018-12-19T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-19T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=57ccd72a-0e17-4440-bc5f-86aa25bd3e3c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=57ccd72a-0e17-4440-bc5f-86aa25bd3e3c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/57ccd72a-0e17-4440-bc5f-86aa25bd3e3c/edition-slot-associations"
        }
      }
    }, {
      "id" : "dae4886c-aab7-4141-926c-9bc7b462dfaa",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "dae4886c-aab7-4141-926c-9bc7b462dfaa",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1134d66e-4176-40ac-adc6-62337001b285",
      "createdBy" : "user",
      "createdDate" : "2018-12-20T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-20T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=dae4886c-aab7-4141-926c-9bc7b462dfaa",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=dae4886c-aab7-4141-926c-9bc7b462dfaa{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dae4886c-aab7-4141-926c-9bc7b462dfaa/edition-slot-associations"
        }
      }
    }, {
      "id" : "0806de1d-31ba-4ba3-9515-6e2c3e8b726d",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "0806de1d-31ba-4ba3-9515-6e2c3e8b726d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d7ef0ddc-c73f-415a-a784-d26572e3a311",
      "createdBy" : "user",
      "createdDate" : "2018-12-21T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-21T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0806de1d-31ba-4ba3-9515-6e2c3e8b726d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0806de1d-31ba-4ba3-9515-6e2c3e8b726d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0806de1d-31ba-4ba3-9515-6e2c3e8b726d/edition-slot-associations"
        }
      }
    }, {
      "id" : "1f1e5633-fd53-4045-b919-50441bb8d4e5",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "1f1e5633-fd53-4045-b919-50441bb8d4e5",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "28763adf-ac6c-4e2b-b44c-a0ee64ea7efa",
      "createdBy" : "user",
      "createdDate" : "2018-12-22T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-22T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1f1e5633-fd53-4045-b919-50441bb8d4e5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1f1e5633-fd53-4045-b919-50441bb8d4e5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f1e5633-fd53-4045-b919-50441bb8d4e5/edition-slot-associations"
        }
      }
    }, {
      "id" : "cacf934d-ad08-4558-b232-2df75d738d0a",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "cacf934d-ad08-4558-b232-2df75d738d0a",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "8ca8b141-0810-41c1-861d-b3fde31f08f6",
      "createdBy" : "user",
      "createdDate" : "2018-12-23T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-23T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cacf934d-ad08-4558-b232-2df75d738d0a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cacf934d-ad08-4558-b232-2df75d738d0a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cacf934d-ad08-4558-b232-2df75d738d0a/edition-slot-associations"
        }
      }
    }, {
      "id" : "53c0f674-70a5-468c-bace-19f9fd7c6dd2",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "53c0f674-70a5-468c-bace-19f9fd7c6dd2",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7530e5b0-4db2-4e2a-8ba4-497f0a1d9dda",
      "createdBy" : "user",
      "createdDate" : "2018-12-24T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-24T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=53c0f674-70a5-468c-bace-19f9fd7c6dd2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=53c0f674-70a5-468c-bace-19f9fd7c6dd2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/53c0f674-70a5-468c-bace-19f9fd7c6dd2/edition-slot-associations"
        }
      }
    }, {
      "id" : "129344b0-bb87-4824-9548-f8002564028e",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "129344b0-bb87-4824-9548-f8002564028e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "89938143-90cd-4c09-bdfb-c1f340ea3c93",
      "createdBy" : "user",
      "createdDate" : "2018-12-25T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-25T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=129344b0-bb87-4824-9548-f8002564028e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=129344b0-bb87-4824-9548-f8002564028e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/129344b0-bb87-4824-9548-f8002564028e/edition-slot-associations"
        }
      }
    }, {
      "id" : "9d5be8ac-14fe-4927-ab7c-87083f0a58cc",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "9d5be8ac-14fe-4927-ab7c-87083f0a58cc",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b79c26b8-31f2-412b-acb6-0d73cd9d51b0",
      "createdBy" : "user",
      "createdDate" : "2018-12-26T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-26T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9d5be8ac-14fe-4927-ab7c-87083f0a58cc",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9d5be8ac-14fe-4927-ab7c-87083f0a58cc{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d5be8ac-14fe-4927-ab7c-87083f0a58cc/edition-slot-associations"
        }
      }
    }, {
      "id" : "a87446a9-5f0f-4877-bbc9-91f8339e1a7b",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "a87446a9-5f0f-4877-bbc9-91f8339e1a7b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "fa0dc257-4d2b-4437-8350-66b97d3e4f94",
      "createdBy" : "user",
      "createdDate" : "2018-12-27T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-27T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a87446a9-5f0f-4877-bbc9-91f8339e1a7b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a87446a9-5f0f-4877-bbc9-91f8339e1a7b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a87446a9-5f0f-4877-bbc9-91f8339e1a7b/edition-slot-associations"
        }
      }
    }, {
      "id" : "96db99fa-ea4f-44ab-8e41-61e50141bb95",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "96db99fa-ea4f-44ab-8e41-61e50141bb95",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "a7c5295e-6d9a-49e2-8bdf-19546413668b",
      "createdBy" : "user",
      "createdDate" : "2018-12-28T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-28T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=96db99fa-ea4f-44ab-8e41-61e50141bb95",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=96db99fa-ea4f-44ab-8e41-61e50141bb95{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96db99fa-ea4f-44ab-8e41-61e50141bb95/edition-slot-associations"
        }
      }
    }, {
      "id" : "406da0c0-068e-496d-a5c2-5d83f2589eaa",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "406da0c0-068e-496d-a5c2-5d83f2589eaa",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "db0722f5-6f56-4f62-9422-7f6a39bdbc00",
      "createdBy" : "user",
      "createdDate" : "2018-12-29T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-29T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=406da0c0-068e-496d-a5c2-5d83f2589eaa",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=406da0c0-068e-496d-a5c2-5d83f2589eaa{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/406da0c0-068e-496d-a5c2-5d83f2589eaa/edition-slot-associations"
        }
      }
    }, {
      "id" : "c8e00f35-c234-462d-8e3c-0aed9cf02ca9",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "c8e00f35-c234-462d-8e3c-0aed9cf02ca9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "abcaf97d-4e52-49f4-b403-468666fa9fce",
      "createdBy" : "user",
      "createdDate" : "2018-12-30T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-30T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c8e00f35-c234-462d-8e3c-0aed9cf02ca9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c8e00f35-c234-462d-8e3c-0aed9cf02ca9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c8e00f35-c234-462d-8e3c-0aed9cf02ca9/edition-slot-associations"
        }
      }
    }, {
      "id" : "75cf439b-7b3d-49f9-8c17-ca4b7533320d",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "75cf439b-7b3d-49f9-8c17-ca4b7533320d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1170acd6-8ba3-4bd1-be20-21082c89f67a",
      "createdBy" : "user",
      "createdDate" : "2018-12-31T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-12-31T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=75cf439b-7b3d-49f9-8c17-ca4b7533320d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=75cf439b-7b3d-49f9-8c17-ca4b7533320d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/75cf439b-7b3d-49f9-8c17-ca4b7533320d/edition-slot-associations"
        }
      }
    }, {
      "id" : "ad080223-66a7-4299-b8af-3fff33ea661a",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "ad080223-66a7-4299-b8af-3fff33ea661a",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "f8f67167-fd7b-4662-b7ef-9bf8fdd91253",
      "createdBy" : "user",
      "createdDate" : "2019-01-01T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-01T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ad080223-66a7-4299-b8af-3fff33ea661a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ad080223-66a7-4299-b8af-3fff33ea661a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ad080223-66a7-4299-b8af-3fff33ea661a/edition-slot-associations"
        }
      }
    }, {
      "id" : "377fdb02-ffbd-4115-af17-f950c59f3407",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "377fdb02-ffbd-4115-af17-f950c59f3407",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7cce9545-2d35-46c8-a15d-a32e4722f705",
      "createdBy" : "user",
      "createdDate" : "2019-01-02T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-02T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=377fdb02-ffbd-4115-af17-f950c59f3407",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=377fdb02-ffbd-4115-af17-f950c59f3407{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/377fdb02-ffbd-4115-af17-f950c59f3407/edition-slot-associations"
        }
      }
    }, {
      "id" : "198a60df-3302-4780-943a-71e84b44b63a",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "198a60df-3302-4780-943a-71e84b44b63a",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "a1d2fbf2-ffc2-45d8-abbc-edb36e372f3d",
      "createdBy" : "user",
      "createdDate" : "2019-01-03T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-03T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=198a60df-3302-4780-943a-71e84b44b63a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=198a60df-3302-4780-943a-71e84b44b63a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/198a60df-3302-4780-943a-71e84b44b63a/edition-slot-associations"
        }
      }
    }, {
      "id" : "5c473869-8b70-473d-b07f-d4a8b308d626",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "5c473869-8b70-473d-b07f-d4a8b308d626",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1567be5c-5ad9-4aae-98b8-8d50e167cb45",
      "createdBy" : "user",
      "createdDate" : "2019-01-04T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-04T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5c473869-8b70-473d-b07f-d4a8b308d626",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5c473869-8b70-473d-b07f-d4a8b308d626{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5c473869-8b70-473d-b07f-d4a8b308d626/edition-slot-associations"
        }
      }
    }, {
      "id" : "058f0719-8c15-4410-8724-1ea0cb8d1f71",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "058f0719-8c15-4410-8724-1ea0cb8d1f71",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "41f5764a-9452-49b4-8a05-a81b0e932291",
      "createdBy" : "user",
      "createdDate" : "2019-01-05T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-05T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=058f0719-8c15-4410-8724-1ea0cb8d1f71",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=058f0719-8c15-4410-8724-1ea0cb8d1f71{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/058f0719-8c15-4410-8724-1ea0cb8d1f71/edition-slot-associations"
        }
      }
    }, {
      "id" : "d89138a7-3847-4495-b57e-a0112b69e5ec",
      "contentRepositoryId" : "5c3ef0d34cedfd01c048d090",
      "folderId" : null,
      "deliveryId" : "d89138a7-3847-4495-b57e-a0112b69e5ec",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3884126c-9fc3-4f52-a18d-60ae2abb7aa8",
      "createdBy" : "user",
      "createdDate" : "2019-01-06T08:52:34.895Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-06T08:52:34.895Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0d34cedfd01c048d090"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d89138a7-3847-4495-b57e-a0112b69e5ec",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d89138a7-3847-4495-b57e-a0112b69e5ec{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d89138a7-3847-4495-b57e-a0112b69e5ec/edition-slot-associations"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0d34cedfd01c048d08a/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0d34cedfd01c048d08a/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0d34cedfd01c048d08a/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0d34cedfd01c048d08a/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
    } ]
  }
}

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/f75512b4-cd1d-45c0-b34d-9d82e1f5373f/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/5c3ef0fd4cedfd01c048d40c

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/ece521d9-fc37-4dc6-8780-fa9931bd4b67/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: 1332

{
  "contentItemId" : "ece521d9-fc37-4dc6-8780-fa9931bd4b67",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5c3ef0ca4cedfd01c048d042",
    "eventStart" : "2019-01-16T08:52:26.003Z",
    "eventEnd" : "2019-02-16T08:52:26.003Z",
    "editionTitle" : "Test",
    "editionId" : "5c3ef0ca4cedfd01c048d043",
    "editionStart" : "2019-01-16T08:52:26.003Z",
    "editionEnd" : "2019-02-16T08:52:26.003Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5c3ef0ca4cedfd01c048d048",
    "editionSlotLocked" : true,
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-01-16T08:52:26.483Z",
    "snapshotId" : "5c3ef0ca4cedfd01c048d04e",
    "usageCount" : 1,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5c3ef0ca4cedfd01c048d043/slots/5c3ef0ca4cedfd01c048d048"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5c3ef0ca4cedfd01c048d043/slots/5c3ef0ca4cedfd01c048d048/content"
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece521d9-fc37-4dc6-8780-fa9931bd4b67/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.

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

{
  "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."
}

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

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

Get an Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/events/5c3ef12c4cedfd01c048e5a0 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: 1118

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

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

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5c3ef12c4cedfd01c048e59f/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: 1916

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

{
  "name" : "shoes",
  "start" : "2019-01-16T09:53:58.438Z",
  "end" : "2019-01-16T12:53:58.438Z",
  "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
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1101

{
  "id" : "5c3ef1264cedfd01c048de86",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-01-16T09:53:58.438Z",
  "end" : "2019-01-16T12:53:58.438Z",
  "brief" : "http://test/path2",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de85"
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86/editions{?page,size,sort}",
      "templated" : true
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de86/editions{?sourceEditionId}",
      "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/5c3ef12c4cedfd01c048e59e 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=5c3ef1264cedfd01c048de87&rangeEnd=2019-01-19T08:53:58.577Z&rangeStart=2019-01-13T08:53:58.577Z&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: 7175

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef1264cedfd01c048de8f",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-01-10T08:53:58.577Z",
      "end" : "2019-01-13T08:53:58.577Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de87"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8f/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef1264cedfd01c048de8d",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-01-10T08:53:58.577Z",
      "end" : "2019-01-14T08:53:58.577Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de87"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8d/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef1264cedfd01c048de8b",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-01-16T08:53:58.577Z",
      "end" : "2019-01-18T08:53:58.577Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de87"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8b/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef1264cedfd01c048de8c",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-01-18T08:53:58.577Z",
      "end" : "2019-01-22T08:53:58.577Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de87"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8c/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef1264cedfd01c048de8e",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-01-19T08:53:58.577Z",
      "end" : "2019-01-22T08:53:58.577Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de87"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de8e/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef1264cedfd01c048de87&rangeStart=2019-01-13T08:53:58.577Z&rangeEnd=2019-01-19T08:53:58.577Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef1264cedfd01c048de87&rangeStart=2019-01-13T08:53:58.577Z&rangeEnd=2019-01-19T08:53:58.577Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef1264cedfd01c048de87&rangeStart=2019-01-13T08:53:58.577Z&rangeEnd=2019-01-19T08:53:58.577Z&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=5c3ef12b4cedfd01c048e585&rangeEnd=2019-01-19T08:54:03.634Z&rangeStart=2019-01-13T08:54:03.634Z&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: 2996

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef12b4cedfd01c048e586",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-01-17T08:54:03.634Z",
      "end" : "2019-01-18T08:54:03.634Z",
      "brief" : "http://host/test/brief",
      "editions" : [ {
        "id" : "5c3ef12b4cedfd01c048e587",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-01-17T08:54:03.634Z",
        "end" : "2019-01-18T08:54:03.634Z",
        "eventId" : "5c3ef12b4cedfd01c048e586",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:03.776Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:03.776Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:03.776Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12b4cedfd01c048e585"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e586/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e585&rangeStart=2019-01-13T08:54:03.634Z&rangeEnd=2019-01-19T08:54:03.634Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e585&rangeStart=2019-01-13T08:54:03.634Z&rangeEnd=2019-01-19T08:54:03.634Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e585&rangeStart=2019-01-13T08:54:03.634Z&rangeEnd=2019-01-19T08:54:03.634Z&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=5c3ef12b4cedfd01c048e58c&rangeStart=2019-01-16T08:54:03.898Z&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: 4591

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef12b4cedfd01c048e590",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-01-14T08:54:03.898Z",
      "end" : "2019-01-18T08:54:03.898Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12b4cedfd01c048e58c"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e590/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef12b4cedfd01c048e58f",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-01-16T08:54:03.898Z",
      "end" : "2019-01-18T08:54:03.898Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12b4cedfd01c048e58c"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58f/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef12b4cedfd01c048e58e",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-01-17T08:54:03.898Z",
      "end" : "2019-01-18T08:54:03.898Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12b4cedfd01c048e58c"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12b4cedfd01c048e58e/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e58c&rangeStart=2019-01-16T08:54:03.898Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e58c&rangeStart=2019-01-16T08:54:03.898Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12b4cedfd01c048e58c&rangeStart=2019-01-16T08:54:03.898Z&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=5c3ef12c4cedfd01c048e593&rangeEnd=2019-01-15T23: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: 2195

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef12c4cedfd01c048e597",
      "name" : "Yesterday",
      "comment" : "This is an event.",
      "start" : "2019-01-15T00:00:00.000Z",
      "end" : "2019-01-15T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12c4cedfd01c048e593"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e597/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-01-15T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-01-15T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-01-15T23: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=5c3ef12c4cedfd01c048e593&rangeEnd=2019-01-16T23:59:59.999Z&rangeStart=2019-01-16T00: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: 2442

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef12c4cedfd01c048e59b",
      "name" : "Yesterday to Today",
      "comment" : "This is an event.",
      "start" : "2019-01-15T00:00:00.000Z",
      "end" : "2019-01-16T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12c4cedfd01c048e593"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e59b/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-16T00:00:00.000Z&rangeEnd=2019-01-16T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-16T00:00:00.000Z&rangeEnd=2019-01-16T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-16T00:00:00.000Z&rangeEnd=2019-01-16T23:59:59.999Z&bounded=false&page=1&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-16T00:00:00.000Z&rangeEnd=2019-01-16T23: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=5c3ef12c4cedfd01c048e593&rangeEnd=2019-01-17T23:59:59.999Z&rangeStart=2019-01-17T00: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: 2194

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef12c4cedfd01c048e599",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-01-17T00:00:00.000Z",
      "end" : "2019-01-17T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef12c4cedfd01c048e593"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef12c4cedfd01c048e599/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-17T00:00:00.000Z&rangeEnd=2019-01-17T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-17T00:00:00.000Z&rangeEnd=2019-01-17T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c3ef12c4cedfd01c048e593&rangeStart=2019-01-17T00:00:00.000Z&rangeEnd=2019-01-17T23: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=5c3ef1264cedfd01c048de92&rangeEnd=2019-01-19T08:53:58.779Z&rangeStart=2019-01-13T08:53:58.779Z&bounded=0&slots=57f9e001-eebd-49f6-b693-afbf68ef3270&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" : "5c3ef1264cedfd01c048de96",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-01-16T08:53:58.779Z",
      "end" : "2019-01-18T08:53:58.779Z",
      "brief" : "http://host/test/brief",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1264cedfd01c048de92"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1264cedfd01c048de96/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1264cedfd01c048de92&rangeStart=2019-01-13T08:53:58.779Z&rangeEnd=2019-01-19T08:53:58.779Z&bounded=false&slots=57f9e001-eebd-49f6-b693-afbf68ef3270&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1264cedfd01c048de92&rangeStart=2019-01-13T08:53:58.779Z&rangeEnd=2019-01-19T08:53:58.779Z&bounded=false&slots=57f9e001-eebd-49f6-b693-afbf68ef3270&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1264cedfd01c048de92&rangeStart=2019-01-13T08:53:58.779Z&rangeEnd=2019-01-19T08:53:58.779Z&bounded=false&slots=57f9e001-eebd-49f6-b693-afbf68ef3270&page=0&size=1"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 1,
    "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=5c3ef1274cedfd01c048de9b&rangeEnd=2019-01-19T08:53:58.993Z&rangeStart=2019-01-13T08:53:58.993Z&bounded=0&projection=withEditions&slots=f5181c73-6b7c-4c9c-bb7c-a94badaf9030&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: 40476

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c3ef1274cedfd01c048dea1",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-01-16T08:53:58.993Z",
      "end" : "2019-01-18T08:53:58.993Z",
      "brief" : "http://host/test/brief",
      "editions" : [ {
        "id" : "5c3ef1274cedfd01c048dea2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.127Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.128Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.146Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dea4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.155Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.155Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.175Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dea7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.185Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.186Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.205Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048deab",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.215Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.215Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.234Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048deb0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.243Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.243Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.262Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048deb6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.271Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.271Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.296Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048debd",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.306Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.307Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.329Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dec5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.338Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.339Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.367Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dece",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.376Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.377Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.402Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048ded8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.412Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.412Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.438Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dee3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.448Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.449Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.477Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048deef",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.488Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.488Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.516Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048defc",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.527Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.527Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.554Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df0a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.565Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.566Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.596Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df19",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.606Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.606Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.635Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df29",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.645Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.646Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.676Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df3a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.688Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.689Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.723Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df4c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.733Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.733Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.764Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df5f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.776Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.776Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.807Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df73",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.817Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.818Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.856Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df88",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.866Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.866Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.901Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048df9e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.911Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.912Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:53:59.946Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1274cedfd01c048dfb5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:53:59.987Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:53:59.987Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.025Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048dfcd",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.036Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.037Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.075Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048dfe6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.086Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.086Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.122Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e000",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.132Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.133Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.185Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e01b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.198Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.199Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.244Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e037",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.254Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.255Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.308Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e054",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.320Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.320Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.368Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e072",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.378Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.378Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.418Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e091",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.428Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.429Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.469Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e0b1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.480Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.481Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.526Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e0d2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.539Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.539Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.580Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e0f4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.591Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.591Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.632Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e117",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.642Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.642Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.680Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e13b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.690Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.690Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.735Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e160",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.745Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.746Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.800Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e186",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.811Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.812Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.863Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e1ad",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.874Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.874Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.912Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e1d5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.922Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.922Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:00.960Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1284cedfd01c048e1fe",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:00.969Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:00.969Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.010Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e228",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.022Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.023Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.065Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e253",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.077Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.077Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.124Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e27f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.134Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.135Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.184Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e2ac",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.194Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.194Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.244Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e2da",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.254Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.255Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.305Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e309",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.315Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.315Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.370Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e339",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.381Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.381Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.446Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e36a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.459Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.460Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.527Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c3ef1294cedfd01c048e39c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-01-16T08:53:58.993Z",
        "end" : "2019-01-18T08:53:58.993Z",
        "eventId" : "5c3ef1274cedfd01c048dea1",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-01-16T08:54:01.538Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-01-16T08:54:01.538Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-01-16T08:54:01.588Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1274cedfd01c048de9b"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1274cedfd01c048dea1/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1274cedfd01c048de9b&rangeStart=2019-01-13T08:53:58.993Z&rangeEnd=2019-01-19T08:53:58.993Z&bounded=false&slots=f5181c73-6b7c-4c9c-bb7c-a94badaf9030&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1274cedfd01c048de9b&rangeStart=2019-01-13T08:53:58.993Z&rangeEnd=2019-01-19T08:53:58.993Z&bounded=false&slots=f5181c73-6b7c-4c9c-bb7c-a94badaf9030&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c3ef1274cedfd01c048de9b&rangeStart=2019-01-13T08:53:58.993Z&rangeEnd=2019-01-19T08:53:58.993Z&bounded=false&slots=f5181c73-6b7c-4c9c-bb7c-a94badaf9030&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/5c3ef12c4cedfd01c048e5a0/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: Wed, 16 Jan 2019 08:54:04 GMT
Location: https://api.amplience.net/v2/content/editions/5c3ef12c4cedfd01c048e5a1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

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

{
  "name" : "Test",
  "start" : "2019-01-16T08:52:26.003Z",
  "end" : "2019-02-16T08:52:26.003Z",
  "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: Wed, 16 Jan 2019 08:53:23 GMT
Location: https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2619

{
  "id" : "5c3ef1034cedfd01c048d52f",
  "name" : "Test",
  "comment" : "This is an example edition.",
  "start" : "2019-01-16T08:52:26.003Z",
  "end" : "2019-02-16T08:52:26.003Z",
  "eventId" : "5c3ef1024cedfd01c048d51f",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 197,
  "versionConflicts" : {
    "limitExceeded" : false,
    "conflicts" : 0
  },
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-01-16T08:53:23.121Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-01-16T08:53:23.122Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:53:23.122Z",
  "stagedDate" : null,
  "slotCollisions" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1024cedfd01c048d51f"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1034cedfd01c048d52f/slot-collisions"
    }
  }
}

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

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

{
  "name" : "New Name",
  "start" : "2019-01-16T08:52:26.003Z",
  "end" : "2019-01-22T08:52:26.003Z",
  "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: Wed, 16 Jan 2019 08:53:52 GMT
Location: https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2545

{
  "id" : "5c3ef1204cedfd01c048d679",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-01-16T08:52:26.003Z",
  "end" : "2019-01-22T08:52:26.003Z",
  "eventId" : "5c3ef1204cedfd01c048d678",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-01-16T08:53:52.795Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-01-16T08:53:52.796Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:53:52.816Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5c3ef1204cedfd01c048d678"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d679/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/5c3ef1014cedfd01c048d4de 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/5c3ef11f4cedfd01c048d650/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-01-16T08:53:52.152Z"
}

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

{
  "lastModifiedDate" : "2019-01-16T08:53:38.209Z",
  "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: 47

{
  "snapshotId" : "5c3ef1124cedfd01c048d5e0"
}

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/5c3ef1034cedfd01c048d55a/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: 47

{
  "snapshotId" : "5c3ef1044cedfd01c048d565"
}

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

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/search/findByEvent?eventId=5c3ef1204cedfd01c048d67b 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" : "5c3ef1204cedfd01c048d67d",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-01-16T08:52:26.003Z",
      "end" : "2019-01-16T10:52:26.003Z",
      "eventId" : "5c3ef1204cedfd01c048d67b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-01-16T08:53:52.922Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:52.923Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:52.923Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1204cedfd01c048d67b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67d/slot-collisions"
        }
      }
    }, {
      "id" : "5c3ef1204cedfd01c048d67c",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-01-16T09:52:26.003Z",
      "end" : "2019-01-16T10:52:26.003Z",
      "eventId" : "5c3ef1204cedfd01c048d67b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-01-16T08:53:52.911Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:52.912Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:52.912Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1204cedfd01c048d67b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67c/slot-collisions"
        }
      }
    }, {
      "id" : "5c3ef1204cedfd01c048d67e",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-01-16T09:52:27.003Z",
      "end" : "2019-01-16T10:52:26.003Z",
      "eventId" : "5c3ef1204cedfd01c048d67b",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-01-16T08:53:52.964Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:52.965Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-01-16T08:53:52.965Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c3ef1204cedfd01c048d67b"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1204cedfd01c048d67e/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c3ef1204cedfd01c048d67b&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c3ef1204cedfd01c048d67b&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c3ef1204cedfd01c048d67b&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/5c3ef1024cedfd01c048d515/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" : "02f1e115-c4f8-490b-a3a9-859c3cfcd551",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1024cedfd01c048d515/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1024cedfd01c048d515"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1024cedfd01c048d515/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/5c3ef1014cedfd01c048d4eb/conflicts/findByIdAndVersion?id=871e1700-4d9b-4773-9dde-531559e4dda9&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" : "5c3ef1014cedfd01c048d4eb",
  "contentItemId" : "871e1700-4d9b-4773-9dde-531559e4dda9",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5c3ef1014cedfd01c048d4ec",
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:53:21.687Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5c3ef1014cedfd01c048d4ee",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "871e1700-4d9b-4773-9dde-531559e4dda9",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1014cedfd01c048d4eb/conflicts/findByIdAndVersion?id=871e1700-4d9b-4773-9dde-531559e4dda9&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1014cedfd01c048d4eb"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1014cedfd01c048d4eb/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/5c3ef1024cedfd01c048d4fa/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-01-16T08:53:22.222Z",
  "resolutions" : [ {
    "contentItemId" : "34124fb2-3f1a-4d90-9606-7202d9d8e306",
    "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/5c3ef1014cedfd01c048d4d5/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" : "5c3ef1014cedfd01c048d4d5",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-01-16T08:52:26.003Z",
    "endDateTime" : "2019-02-16T08:52:26.003Z",
    "editionId" : "5c3ef1014cedfd01c048d4d0",
    "collidingSlotIds" : [ "c0aa79a0-e1a1-4fec-80fe-c2bc8e69cae2", "01b46439-6597-4875-95df-c95f445c2842" ],
    "eventName" : "Test",
    "eventId" : "5c3ef1014cedfd01c048d4cf"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1014cedfd01c048d4d5/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1014cedfd01c048d4d5/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/5c3ef13d4cedfd01c048e68b/slots?sourceEditionSlotId=5c3ef13d4cedfd01c048e689 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5c3ef13d4cedfd01c048e689

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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: 1305

{
  "id" : "5c3ef13d4cedfd01c048e68c",
  "eventId" : "5c3ef13d4cedfd01c048e68a",
  "editionId" : "5c3ef13d4cedfd01c048e68b",
  "createdDate" : "2019-01-16T08:54:21.914Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c3ef13d4cedfd01c048e681",
  "slotId" : "c9d1c329-6f9d-42f0-9fb1-033a504a765e",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e68b/slots/5c3ef13d4cedfd01c048e68c"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e68b/slots/5c3ef13d4cedfd01c048e68c"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e68b"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9d1c329-6f9d-42f0-9fb1-033a504a765e{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e68b/slots/5c3ef13d4cedfd01c048e68c/content"
    }
  }
}

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/5c3ef13c4cedfd01c048e64f/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: Wed, 16 Jan 2019 08:54:20 GMT
Location: https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3647

{
  "id" : "0db60979-5b06-445b-a154-e73f7b7c11fc",
  "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-01-16T08:54:20.471Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:54:20.471Z",
  "deliveryId" : "0db60979-5b06-445b-a154-e73f7b7c11fc",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef13c4cedfd01c048e64f"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0db60979-5b06-445b-a154-e73f7b7c11fc",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0db60979-5b06-445b-a154-e73f7b7c11fc{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0db60979-5b06-445b-a154-e73f7b7c11fc"
    }
  }
}

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

[ {
  "slot" : "5f361e2a-255f-4ef9-8921-9c416cd6278a"
}, {
  "slot" : "1a620df7-a3be-45e1-b980-0c952e58e6bb"
}, {
  "slot" : "9e29080b-ec07-4812-8471-966df4b0d3c8"
} ]

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

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5c3ef13d4cedfd01c048e67b",
      "eventId" : "5c3ef13d4cedfd01c048e676",
      "editionId" : "5c3ef13d4cedfd01c048e677",
      "createdDate" : "2019-01-16T08:54:21.631Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c3ef13d4cedfd01c048e675",
      "slotId" : "5f361e2a-255f-4ef9-8921-9c416cd6278a",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67b"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67b"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5f361e2a-255f-4ef9-8921-9c416cd6278a{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67b/content"
        }
      }
    }, {
      "id" : "5c3ef13d4cedfd01c048e67c",
      "eventId" : "5c3ef13d4cedfd01c048e676",
      "editionId" : "5c3ef13d4cedfd01c048e677",
      "createdDate" : "2019-01-16T08:54:21.632Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c3ef13d4cedfd01c048e675",
      "slotId" : "1a620df7-a3be-45e1-b980-0c952e58e6bb",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67c"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a620df7-a3be-45e1-b980-0c952e58e6bb{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67c/content"
        }
      }
    }, {
      "id" : "5c3ef13d4cedfd01c048e67d",
      "eventId" : "5c3ef13d4cedfd01c048e676",
      "editionId" : "5c3ef13d4cedfd01c048e677",
      "createdDate" : "2019-01-16T08:54:21.632Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c3ef13d4cedfd01c048e675",
      "slotId" : "9e29080b-ec07-4812-8471-966df4b0d3c8",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67d"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67d"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e29080b-ec07-4812-8471-966df4b0d3c8{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots/5c3ef13d4cedfd01c048e67d/content"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e677/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/5c3ef13d4cedfd01c048e66b/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: 4939

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5c3ef13d4cedfd01c048e671",
      "eventId" : "5c3ef13d4cedfd01c048e66a",
      "editionId" : "5c3ef13d4cedfd01c048e66b",
      "createdDate" : "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" : "5c3ef13d4cedfd01c048e669",
      "slotId" : "c845b3de-93dc-4607-bb71-1eb0f02452f4",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e671"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e671"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c845b3de-93dc-4607-bb71-1eb0f02452f4{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e671/content"
        }
      }
    }, {
      "id" : "5c3ef13d4cedfd01c048e66f",
      "eventId" : "5c3ef13d4cedfd01c048e66a",
      "editionId" : "5c3ef13d4cedfd01c048e66b",
      "createdDate" : "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" : "5c3ef13d4cedfd01c048e669",
      "slotId" : "82d11986-05d0-4ad5-b8b8-ab751d697467",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66f"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66f"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/82d11986-05d0-4ad5-b8b8-ab751d697467{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66f/content"
        }
      }
    }, {
      "id" : "5c3ef13d4cedfd01c048e66d",
      "eventId" : "5c3ef13d4cedfd01c048e66a",
      "editionId" : "5c3ef13d4cedfd01c048e66b",
      "createdDate" : "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" : "5c3ef13d4cedfd01c048e669",
      "slotId" : "6f5ca94d-4227-4938-9dcc-ee4cbec327f9",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66d"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66d"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6f5ca94d-4227-4938-9dcc-ee4cbec327f9{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots/5c3ef13d4cedfd01c048e66d/content"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13d4cedfd01c048e66b/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/5c3ef13e4cedfd01c048e696/slots?includedSlots=43d51ace-0924-4bb7-8cfe-db21a83b4d15 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: 2174

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5c3ef13e4cedfd01c048e698",
      "eventId" : "5c3ef13e4cedfd01c048e692",
      "editionId" : "5c3ef13e4cedfd01c048e696",
      "createdDate" : "2019-01-16T08:54:22.123Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c3ef13e4cedfd01c048e691",
      "slotId" : "43d51ace-0924-4bb7-8cfe-db21a83b4d15",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots/5c3ef13e4cedfd01c048e698"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots/5c3ef13e4cedfd01c048e698"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/43d51ace-0924-4bb7-8cfe-db21a83b4d15{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots/5c3ef13e4cedfd01c048e698/content"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots?includedSlots=43d51ace-0924-4bb7-8cfe-db21a83b4d15&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots?includedSlots=43d51ace-0924-4bb7-8cfe-db21a83b4d15&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13e4cedfd01c048e696/slots?includedSlots=43d51ace-0924-4bb7-8cfe-db21a83b4d15&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/5c3ef12e4cedfd01c048e5dd/slots/5c3ef12e4cedfd01c048e5df 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: 1305

{
  "id" : "5c3ef12e4cedfd01c048e5df",
  "eventId" : "5c3ef12e4cedfd01c048e5dc",
  "editionId" : "5c3ef12e4cedfd01c048e5dd",
  "createdDate" : "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" : "5c3ef12e4cedfd01c048e5db",
  "slotId" : "9a520fa1-b30f-49cb-b64f-af3265f0cf9f",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef12e4cedfd01c048e5dd/slots/5c3ef12e4cedfd01c048e5df"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef12e4cedfd01c048e5dd/slots/5c3ef12e4cedfd01c048e5df"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef12e4cedfd01c048e5dd"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a520fa1-b30f-49cb-b64f-af3265f0cf9f{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef12e4cedfd01c048e5dd/slots/5c3ef12e4cedfd01c048e5df/content"
    }
  }
}

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/5c3ef13c4cedfd01c048e65d/slots/5c3ef13c4cedfd01c048e65f 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/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651/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" : "50799c09-9957-4b95-b68f-78b20ea4cf88",
        "locked" : true
      },
      "id" : "5c3ef13c4cedfd01c048e657",
      "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
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1709

{
  "id" : "5c3ef13c4cedfd01c048e651",
  "eventId" : "5c3ef13c4cedfd01c048e64b",
  "editionId" : "5c3ef13c4cedfd01c048e64c",
  "createdDate" : "2019-01-16T08:54:20.501Z",
  "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" : "50799c09-9957-4b95-b68f-78b20ea4cf88",
          "locked" : true
        },
        "id" : "5c3ef13c4cedfd01c048e657",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c3ef13c4cedfd01c048e64e",
  "slotId" : "0db60979-5b06-445b-a154-e73f7b7c11fc",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651/content"
    }
  }
}

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/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651 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: 1709

{
  "id" : "5c3ef13c4cedfd01c048e651",
  "eventId" : "5c3ef13c4cedfd01c048e64b",
  "editionId" : "5c3ef13c4cedfd01c048e64c",
  "createdDate" : "2019-01-16T08:54:20.501Z",
  "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" : "50799c09-9957-4b95-b68f-78b20ea4cf88",
          "locked" : true
        },
        "id" : "5c3ef13c4cedfd01c048e657",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c3ef13c4cedfd01c048e64e",
  "slotId" : "0db60979-5b06-445b-a154-e73f7b7c11fc",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0db60979-5b06-445b-a154-e73f7b7c11fc{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e64c/slots/5c3ef13c4cedfd01c048e651/content"
    }
  }
}

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/5c3ef13c4cedfd01c048e644/slots/5c3ef13c4cedfd01c048e649 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: 1355

{
  "id" : "5c3ef13c4cedfd01c048e649",
  "eventId" : "5c3ef13c4cedfd01c048e643",
  "editionId" : "5c3ef13c4cedfd01c048e644",
  "createdDate" : "2019-01-16T08:54:20.230Z",
  "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" : "5c3ef13c4cedfd01c048e646",
  "slotId" : "58bcd6f0-262f-4471-9c98-25992e694598",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e644/slots/5c3ef13c4cedfd01c048e649"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e644/slots/5c3ef13c4cedfd01c048e649"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e644"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/58bcd6f0-262f-4471-9c98-25992e694598{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef13c4cedfd01c048e644/slots/5c3ef13c4cedfd01c048e649/content"
    }
  }
}

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/5c3ef1214cedfd01c048d694/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" : "662a04a4-2f22-4ce0-b433-6b03ba6339a9",
  "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/5c3ef1214cedfd01c048d69a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1564

{
  "id" : "5c3ef1214cedfd01c048d69a",
  "comment" : "This is an example snapshot.",
  "createdDate" : "2017-06-05T04:03:02Z",
  "createdBy" : "thor",
  "createdFrom" : "content-item",
  "type" : "USER",
  "meta" : [ ],
  "taggedEditions" : [ ],
  "rootContentItem" : {
    "label" : "Banner Ad Homepage",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "id" : "662a04a4-2f22-4ce0-b433-6b03ba6339a9"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d694"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/662a04a4-2f22-4ce0-b433-6b03ba6339a9"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d69a/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5c3ef1214cedfd01c048d67f/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: 4159

{
  "_embedded" : {
    "snapshots" : [ {
      "id" : "5c3ef1214cedfd01c048d686",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-01-16T08:53:53.236Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "908a2c0f-04f5-42e9-abd3-84afd2904afd"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/908a2c0f-04f5-42e9-abd3-84afd2904afd"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d686/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c3ef1214cedfd01c048d687",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-01-16T08:53:53.247Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "5f7d4dfd-92a5-4c43-aa45-0d092c4b1070"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5f7d4dfd-92a5-4c43-aa45-0d092c4b1070"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1214cedfd01c048d687/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1214cedfd01c048d67f/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/5c3ef1254cedfd01c048de55 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: 1564

{
  "id" : "5c3ef1254cedfd01c048de55",
  "comment" : "This is an example snapshot.",
  "createdDate" : "2017-10-09T08:07:06Z",
  "createdBy" : "user",
  "createdFrom" : "content-item",
  "type" : "USER",
  "meta" : [ ],
  "taggedEditions" : [ ],
  "rootContentItem" : {
    "label" : "Banner Ad Homepage",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "id" : "a58e174f-03d7-4975-9520-fb482fded9a4"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1254cedfd01c048de4f"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a58e174f-03d7-4975-9520-fb482fded9a4"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de55/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/5c3ef1264cedfd01c048de83/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

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

{
  "editionId" : "5c3ef1264cedfd01c048de82",
  "createdDate" : "2019-01-16T08:53:58Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c3ef1264cedfd01c048de82"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1264cedfd01c048de83/edition-links/5c3ef1264cedfd01c048de82"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5c3ef1254cedfd01c048de5e/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" : "5c3ef1254cedfd01c048de64",
      "createdDate" : "2019-01-16T08:53:58Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1254cedfd01c048de64"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links/5c3ef1254cedfd01c048de64"
        }
      }
    }, {
      "editionId" : "5c3ef1254cedfd01c048de65",
      "createdDate" : "2019-01-16T08:53:58Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1254cedfd01c048de65"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links/5c3ef1254cedfd01c048de65"
        }
      }
    }, {
      "editionId" : "5c3ef1254cedfd01c048de66",
      "createdDate" : "2019-01-16T08:53:58Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1254cedfd01c048de66"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links/5c3ef1254cedfd01c048de66"
        }
      }
    }, {
      "editionId" : "5c3ef1254cedfd01c048de67",
      "createdDate" : "2019-01-16T08:53:58Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1254cedfd01c048de67"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links/5c3ef1254cedfd01c048de67"
        }
      }
    }, {
      "editionId" : "5c3ef1254cedfd01c048de68",
      "createdDate" : "2019-01-16T08:53:58Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c3ef1254cedfd01c048de68"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links/5c3ef1254cedfd01c048de68"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef1254cedfd01c048de5e/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/5c3ef12d4cedfd01c048e5b9/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-01-16T09:54:05.580Z"
}
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/5c3ef12d4cedfd01c048e5ba
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5c3ef12d4cedfd01c048e5ba",
  "scheduledDate" : "2019-01-16T09:54:05.580Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c3ef12d4cedfd01c048e5ba"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c3ef12d4cedfd01c048e5ba"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef12d4cedfd01c048e5b9"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c3ef12d4cedfd01c048e5ba"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5c3ef12d4cedfd01c048e5c2 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" : "5c3ef12d4cedfd01c048e5c2",
  "scheduledDate" : "2019-02-16T08:54:05.739Z",
  "createdDate" : "2019-01-16T08:54:05.746Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c3ef12d4cedfd01c048e5c2"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c3ef12d4cedfd01c048e5c2"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c3ef12d4cedfd01c048e5c1"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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

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

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

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

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

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

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request
POST /v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/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: 3783

{
  "id" : "307d9178-f432-43db-89d1-9fc9d042df91",
  "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-01-16T08:52:29.454Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-01-16T08:52:29.490Z",
  "deliveryId" : "307d9178-f432-43db-89d1-9fc9d042df91",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/planned{?epoch,time}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0cd4cedfd01c048d084"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=307d9178-f432-43db-89d1-9fc9d042df91",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=307d9178-f432-43db-89d1-9fc9d042df91{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/307d9178-f432-43db-89d1-9fc9d042df91/edition-slot-associations"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=307d9178-f432-43db-89d1-9fc9d042df91"
    }
  }
}

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/3c600259-ac0a-4426-9df9-f029e18fc9ef/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" : "3c600259-ac0a-4426-9df9-f029e18fc9ef"
  },
  "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/3c600259-ac0a-4426-9df9-f029e18fc9ef"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3c600259-ac0a-4426-9df9-f029e18fc9ef{&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/1f984711-31b2-463a-8f2b-ecbb550cecf0/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" : "1f984711-31b2-463a-8f2b-ecbb550cecf0",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f984711-31b2-463a-8f2b-ecbb550cecf0"
        }
      }
    }, {
      "id" : "3babefc3-d2b8-44c3-9d92-1dab4aa69ab6",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3babefc3-d2b8-44c3-9d92-1dab4aa69ab6"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f984711-31b2-463a-8f2b-ecbb550cecf0/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f984711-31b2-463a-8f2b-ecbb550cecf0/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1f984711-31b2-463a-8f2b-ecbb550cecf0/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=138e6878-0570-4cb1-9256-bc76c84b1f7f 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" : "138e6878-0570-4cb1-9256-bc76c84b1f7f"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-01-16T08:54:06.427Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/138e6878-0570-4cb1-9256-bc76c84b1f7f"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=138e6878-0570-4cb1-9256-bc76c84b1f7f{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=138e6878-0570-4cb1-9256-bc76c84b1f7f&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=138e6878-0570-4cb1-9256-bc76c84b1f7f&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=138e6878-0570-4cb1-9256-bc76c84b1f7f&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 2. 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/5c3ef0ff4cedfd01c048d493/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" : "5c3ef0ff4cedfd01c048d493",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d492"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d492/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef0ff4cedfd01c048d492/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/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/5c3ef0ff4cedfd01c048d493/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c3ef0ff4cedfd01c048d493/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/5c3ef0ff4cedfd01c048d4a6/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "newRepositoryId" : "5c3ef0ff4cedfd01c048d4a4"
}
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/5c3ef0ff4cedfd01c048d4aa/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/5c3ef0ff4cedfd01c048d4aa/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 3. Operations
Operation rel

Manage Access

"access"

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Managing Access

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

Auth rules

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

Example request

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

Example response

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

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

Listing operations for a resource

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

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

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

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/hubs/5c3ef12c4cedfd01c048e5a7 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/5c3ef12c4cedfd01c048e5a7"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12c4cedfd01c048e5a7/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12c4cedfd01c048e5a7/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/5c3ef12c4cedfd01c048e5a6 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/5c3ef12c4cedfd01c048e5a6"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12c4cedfd01c048e5a6/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12c4cedfd01c048e5a6/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/5c3ef12d4cedfd01c048e5a8/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: 2621

{
  "_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" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12d4cedfd01c048e5a8/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/5c3ef12d4cedfd01c048e5aa/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/5c3ef12d4cedfd01c048e5aa/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/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/5c3ef12d4cedfd01c048e5aa/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c3ef12d4cedfd01c048e5aa/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/5c3ef12c4cedfd01c048e5a4/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/5c3ef12c4cedfd01c048e5a4/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c3ef12c4cedfd01c048e5a4/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/5c3ef12c4cedfd01c048e5a2/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/5c3ef12c4cedfd01c048e5a3/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/5c3ef13f4cedfd01c048e69d/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/5c3ef13f4cedfd01c048e69d/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/5c3ef13f4cedfd01c048e69d/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69d"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69d/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69d/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69d/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69d/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/5c3ef13f4cedfd01c048e69a/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/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/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/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/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/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e69a/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/5c3ef1404cedfd01c048e6a4/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/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/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/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/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/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef1404cedfd01c048e6a4/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/5c3ef13f4cedfd01c048e6a2/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/5c3ef13f4cedfd01c048e6a2/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e6a2"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e6a2/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e6a2/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e6a2/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c3ef13f4cedfd01c048e6a2/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

DELETE /v2/content/hubs/5c3ef13f4cedfd01c048e6a1/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