Expand all

Integrating with the API

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

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

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

Example request

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

Example response

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

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

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

Information

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

Supported Localization Settings

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

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Hubs

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

Creating a new Hub

Auth rules

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

Example request

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

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

Example response

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

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

Listing Hubs

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

{
  "_embedded" : {
    "hubs" : [ {
      "id" : "5cdf08f946e0fb036233bc61",
      "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-05-17T19:18:17.076Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:17.076Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc61/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf08f946e0fb036233bc62",
      "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-05-17T19:18:17.109Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:17.109Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc62/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf08f946e0fb036233bc63",
      "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-05-17T19:18:17.144Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:17.144Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "search-localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
        },
        "create-workflow-state" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf08f946e0fb036233bc63/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Updating a Hub

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request

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

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

Example response

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

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

Updating settings

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

Example: Update all of the devices settings:

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT

Example request
PATCH /v2/content/hubs/5cdf096746e0fb036233d4e5/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/5cdf096746e0fb036233d4e5

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

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

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

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

{
  "contentTypeId" : "5cdf092046e0fb036233c892"
}

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

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

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

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

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 17 May 2019 19:18:07 GMT
Location: https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "2beddcbc-c581-4b81-9e8c-685481b759f4",
  "folderId" : "5cdf08ef46e0fb036233b525",
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 1,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "locale" : "en",
  "createdDate" : "2019-05-17T19:18:07.475Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:07.475Z",
  "deliveryId" : "2beddcbc-c581-4b81-9e8c-685481b759f4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2beddcbc-c581-4b81-9e8c-685481b759f4"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08ef46e0fb036233b521"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2beddcbc-c581-4b81-9e8c-685481b759f4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5cdf08ef46e0fb036233b525"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2beddcbc-c581-4b81-9e8c-685481b759f4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2beddcbc-c581-4b81-9e8c-685481b759f4/workflow"
    }
  }
}

Get Content Item by Id

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "b3e2f5b2-cf45-4eca-a719-7cca363f86b3",
  "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-05-17T19:18:06.551Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:06.551Z",
  "deliveryId" : "b3e2f5b2-cf45-4eca-a719-7cca363f86b3",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b3e2f5b2-cf45-4eca-a719-7cca363f86b3"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08ed46e0fb036233b4d3"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b3e2f5b2-cf45-4eca-a719-7cca363f86b3",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b3e2f5b2-cf45-4eca-a719-7cca363f86b3{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3e2f5b2-cf45-4eca-a719-7cca363f86b3/workflow"
    }
  }
}

Update Content Item

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a 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" : "5cdf08ef46e0fb036233b575"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 17 May 2019 19:18:08 GMT
Location: https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "83265188-f639-444e-ae3a-1e547ba2632a",
  "folderId" : "5cdf08ef46e0fb036233b575",
  "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-05-17T19:18:08.015Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:08.088Z",
  "deliveryId" : "83265188-f639-444e-ae3a-1e547ba2632a",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=83265188-f639-444e-ae3a-1e547ba2632a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08ef46e0fb036233b571"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=83265188-f639-444e-ae3a-1e547ba2632a",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5cdf08ef46e0fb036233b575"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=83265188-f639-444e-ae3a-1e547ba2632a{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/83265188-f639-444e-ae3a-1e547ba2632a/workflow"
    }
  }
}

Copy Content Item

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5cdf091f46e0fb036233c7eb/content-items?sourceContentItemId=22a69f29-38d3-469f-a52f-a5c16c4b2386 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 67

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 17 May 2019 19:18:55 GMT
Location: https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "39f8cdf8-2f64-435a-9e96-9428aea488ba",
  "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-05-17T19:18:55.735Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:55.735Z",
  "deliveryId" : "39f8cdf8-2f64-435a-9e96-9428aea488ba",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=39f8cdf8-2f64-435a-9e96-9428aea488ba"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091f46e0fb036233c7eb"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=39f8cdf8-2f64-435a-9e96-9428aea488ba",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=39f8cdf8-2f64-435a-9e96-9428aea488ba{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/39f8cdf8-2f64-435a-9e96-9428aea488ba/workflow"
    }
  }
}

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

Auth rules: Source

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

Required ACLs:
  • Hub - READ

Auth rules: Destination

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

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

POST /v2/content/content-repositories/5cdf091f46e0fb036233c7f2/content-items?sourceContentItemId=d9d5dae9-76a5-4172-a467-7e30c47a359e 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" : "5cdf091f46e0fb036233c7f8"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 17 May 2019 19:18:56 GMT
Location: https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6",
  "folderId" : "5cdf091f46e0fb036233c7f8",
  "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-05-17T19:18:56.026Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:56.026Z",
  "deliveryId" : "bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091f46e0fb036233c7f2"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5cdf091f46e0fb036233c7f8"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bbbe7cec-1618-45fb-a7bd-f4f14a8aa6e6/workflow"
    }
  }
}

Archive Content Item

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - DELETE_CONTENT

Example request

POST /v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/archive HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 19

{
  "version" : 1
}

Example response

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

{
  "id" : "44f8e864-5b26-4bc8-b5e7-4589184afdd4",
  "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-05-17T19:18:23.122Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:23.146Z",
  "deliveryId" : "44f8e864-5b26-4bc8-b5e7-4589184afdd4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=44f8e864-5b26-4bc8-b5e7-4589184afdd4"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08fe46e0fb036233c3ae"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=44f8e864-5b26-4bc8-b5e7-4589184afdd4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=44f8e864-5b26-4bc8-b5e7-4589184afdd4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/44f8e864-5b26-4bc8-b5e7-4589184afdd4/workflow"
    }
  }
}

Unarchive Content Item

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

POST /v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/unarchive HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 19

{
  "version" : 1
}

Example response

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

{
  "id" : "3a45f210-1cbf-4281-aef6-88cfb55c24f5",
  "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" : "3a45f210-1cbf-4281-aef6-88cfb55c24f5",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3a45f210-1cbf-4281-aef6-88cfb55c24f5"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c454"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3a45f210-1cbf-4281-aef6-88cfb55c24f5",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3a45f210-1cbf-4281-aef6-88cfb55c24f5{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3a45f210-1cbf-4281-aef6-88cfb55c24f5/workflow"
    }
  }
}

Update multiple Content Items

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

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

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

[ {
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting",
    "newField" : "value"
  },
  "label" : "Banner Ad Homepage",
  "version" : 1,
  "folderId" : "5cdf08f146e0fb036233b665",
  "id" : "68903384-fb6d-4c3f-843e-13ef611891ce"
}, {
  "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" : "5cdf08f146e0fb036233b665",
  "id" : "1e9c81d9-f286-440a-872f-ea7f29d45ecf"
} ]

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" : "68903384-fb6d-4c3f-843e-13ef611891ce",
    "status" : 200,
    "description" : null
  }, {
    "id" : "1e9c81d9-f286-440a-872f-ea7f29d45ecf",
    "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/5cdf08f046e0fb036233b5c1/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "c9f8a45f-a56a-41a1-89c3-54d617cc1a12",
      "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-05-17T19:18:08.740Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:08.740Z",
      "deliveryId" : "c9f8a45f-a56a-41a1-89c3-54d617cc1a12",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c9f8a45f-a56a-41a1-89c3-54d617cc1a12"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c9f8a45f-a56a-41a1-89c3-54d617cc1a12",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c9f8a45f-a56a-41a1-89c3-54d617cc1a12{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c9f8a45f-a56a-41a1-89c3-54d617cc1a12/workflow"
        }
      }
    }, {
      "id" : "2d0a7dd9-99c5-4675-9374-2c36c3b6659c",
      "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-05-17T19:18:08.664Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:08.664Z",
      "deliveryId" : "2d0a7dd9-99c5-4675-9374-2c36c3b6659c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2d0a7dd9-99c5-4675-9374-2c36c3b6659c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2d0a7dd9-99c5-4675-9374-2c36c3b6659c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2d0a7dd9-99c5-4675-9374-2c36c3b6659c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2d0a7dd9-99c5-4675-9374-2c36c3b6659c/workflow"
        }
      }
    }, {
      "id" : "a3afc460-5e4b-4329-b247-036f79ff6231",
      "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-05-17T19:18:08.589Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:08.589Z",
      "deliveryId" : "a3afc460-5e4b-4329-b247-036f79ff6231",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a3afc460-5e4b-4329-b247-036f79ff6231"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a3afc460-5e4b-4329-b247-036f79ff6231",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a3afc460-5e4b-4329-b247-036f79ff6231{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3afc460-5e4b-4329-b247-036f79ff6231/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f046e0fb036233b5c1/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/5cdf091346e0fb036233c6fa/content-items?projection=basic HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "createdBy" : "user",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "label" : "Banner Ad Homepage",
      "deliveryId" : "fd9985b9-3d33-477d-84e8-aa56b888c7b6",
      "folderId" : null,
      "locale" : "en",
      "version" : 1,
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "status" : "ACTIVE",
      "id" : "fd9985b9-3d33-477d-84e8-aa56b888c7b6",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fd9985b9-3d33-477d-84e8-aa56b888c7b6"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091346e0fb036233c6fa"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fd9985b9-3d33-477d-84e8-aa56b888c7b6",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fd9985b9-3d33-477d-84e8-aa56b888c7b6{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fd9985b9-3d33-477d-84e8-aa56b888c7b6/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091346e0fb036233c6fa/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091346e0fb036233c6fa/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091346e0fb036233c6fa/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091346e0fb036233c6fa/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/5cdf08f146e0fb036233b611/content-items?sort=label%2Casc HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "4fff1a25-39dc-40ec-bf1a-40abf1c0a906",
      "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-05-17T19:18:09.341Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:09.341Z",
      "deliveryId" : "4fff1a25-39dc-40ec-bf1a-40abf1c0a906",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4fff1a25-39dc-40ec-bf1a-40abf1c0a906"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4fff1a25-39dc-40ec-bf1a-40abf1c0a906",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4fff1a25-39dc-40ec-bf1a-40abf1c0a906{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4fff1a25-39dc-40ec-bf1a-40abf1c0a906/workflow"
        }
      }
    }, {
      "id" : "92b3c1ef-57ba-4534-88e0-0427ced7d518",
      "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-05-17T19:18:09.393Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:09.393Z",
      "deliveryId" : "92b3c1ef-57ba-4534-88e0-0427ced7d518",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=92b3c1ef-57ba-4534-88e0-0427ced7d518"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=92b3c1ef-57ba-4534-88e0-0427ced7d518",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=92b3c1ef-57ba-4534-88e0-0427ced7d518{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/92b3c1ef-57ba-4534-88e0-0427ced7d518/workflow"
        }
      }
    }, {
      "id" : "49556da1-f6c7-4bf0-aad4-d0fe976cd587",
      "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-05-17T19:18:09.445Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:09.445Z",
      "deliveryId" : "49556da1-f6c7-4bf0-aad4-d0fe976cd587",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=49556da1-f6c7-4bf0-aad4-d0fe976cd587"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=49556da1-f6c7-4bf0-aad4-d0fe976cd587",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=49556da1-f6c7-4bf0-aad4-d0fe976cd587{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49556da1-f6c7-4bf0-aad4-d0fe976cd587/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f146e0fb036233b611/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/5cdf090146e0fb036233c4b0/content-items?folderId=5cdf090146e0fb036233c4b4 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "031a805e-9efa-408c-be06-ba80336726e3",
      "folderId" : "5cdf090146e0fb036233c4b4",
      "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-05-17T19:18:25.156Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.156Z",
      "deliveryId" : "031a805e-9efa-408c-be06-ba80336726e3",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=031a805e-9efa-408c-be06-ba80336726e3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4b0"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=031a805e-9efa-408c-be06-ba80336726e3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4b4"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=031a805e-9efa-408c-be06-ba80336726e3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/031a805e-9efa-408c-be06-ba80336726e3/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4b0/content-items?folderId=5cdf090146e0fb036233c4b4&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4b0/content-items?folderId=5cdf090146e0fb036233c4b4&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4b0/content-items?folderId=5cdf090146e0fb036233c4b4&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4b0/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/5cdf090046e0fb036233c4a4/content-items?folderId=5cdf090046e0fb036233c4a8,5cdf090046e0fb036233c4a9 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "31e0934c-e904-4710-9532-d3c1c8a6db13",
      "folderId" : "5cdf090046e0fb036233c4a9",
      "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-05-17T19:18:24.926Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:24.926Z",
      "deliveryId" : "31e0934c-e904-4710-9532-d3c1c8a6db13",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=31e0934c-e904-4710-9532-d3c1c8a6db13"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=31e0934c-e904-4710-9532-d3c1c8a6db13",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090046e0fb036233c4a9"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=31e0934c-e904-4710-9532-d3c1c8a6db13{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/31e0934c-e904-4710-9532-d3c1c8a6db13/workflow"
        }
      }
    }, {
      "id" : "d3934180-b33b-46c0-9976-a3e4d4636ceb",
      "folderId" : "5cdf090046e0fb036233c4a9",
      "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-05-17T19:18:24.900Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:24.900Z",
      "deliveryId" : "d3934180-b33b-46c0-9976-a3e4d4636ceb",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d3934180-b33b-46c0-9976-a3e4d4636ceb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d3934180-b33b-46c0-9976-a3e4d4636ceb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090046e0fb036233c4a9"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d3934180-b33b-46c0-9976-a3e4d4636ceb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d3934180-b33b-46c0-9976-a3e4d4636ceb/workflow"
        }
      }
    }, {
      "id" : "0985a744-1b5f-4af6-b6b8-26c8191aa282",
      "folderId" : "5cdf090046e0fb036233c4a9",
      "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-05-17T19:18:24.866Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:24.866Z",
      "deliveryId" : "0985a744-1b5f-4af6-b6b8-26c8191aa282",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0985a744-1b5f-4af6-b6b8-26c8191aa282"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0985a744-1b5f-4af6-b6b8-26c8191aa282",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090046e0fb036233c4a9"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0985a744-1b5f-4af6-b6b8-26c8191aa282{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0985a744-1b5f-4af6-b6b8-26c8191aa282/workflow"
        }
      }
    }, {
      "id" : "23ad5d9d-a644-4d74-a1fb-34bc4e725d8c",
      "folderId" : "5cdf090046e0fb036233c4a8",
      "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-05-17T19:18:24.812Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:24.812Z",
      "deliveryId" : "23ad5d9d-a644-4d74-a1fb-34bc4e725d8c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=23ad5d9d-a644-4d74-a1fb-34bc4e725d8c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=23ad5d9d-a644-4d74-a1fb-34bc4e725d8c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090046e0fb036233c4a8"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=23ad5d9d-a644-4d74-a1fb-34bc4e725d8c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/23ad5d9d-a644-4d74-a1fb-34bc4e725d8c/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4/content-items?folderId=5cdf090046e0fb036233c4a8,5cdf090046e0fb036233c4a9&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4/content-items?folderId=5cdf090046e0fb036233c4a8,5cdf090046e0fb036233c4a9&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4/content-items?folderId=5cdf090046e0fb036233c4a8,5cdf090046e0fb036233c4a9&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090046e0fb036233c4a4/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/5cdf090146e0fb036233c4bc/content-items?folderId=5cdf090146e0fb036233c4c0&folderId=5cdf090146e0fb036233c4c1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "3b41946d-8246-485b-a5ad-d2aa108e662d",
      "folderId" : "5cdf090146e0fb036233c4c1",
      "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-05-17T19:18:25.587Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.587Z",
      "deliveryId" : "3b41946d-8246-485b-a5ad-d2aa108e662d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3b41946d-8246-485b-a5ad-d2aa108e662d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3b41946d-8246-485b-a5ad-d2aa108e662d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4c1"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3b41946d-8246-485b-a5ad-d2aa108e662d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3b41946d-8246-485b-a5ad-d2aa108e662d/workflow"
        }
      }
    }, {
      "id" : "c68283f0-7802-4e27-bfa2-875787c07b3e",
      "folderId" : "5cdf090146e0fb036233c4c1",
      "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-05-17T19:18:25.552Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.552Z",
      "deliveryId" : "c68283f0-7802-4e27-bfa2-875787c07b3e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c68283f0-7802-4e27-bfa2-875787c07b3e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c68283f0-7802-4e27-bfa2-875787c07b3e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4c1"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c68283f0-7802-4e27-bfa2-875787c07b3e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c68283f0-7802-4e27-bfa2-875787c07b3e/workflow"
        }
      }
    }, {
      "id" : "bb380f84-5f21-4197-9df2-0639ba53264f",
      "folderId" : "5cdf090146e0fb036233c4c1",
      "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-05-17T19:18:25.522Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.522Z",
      "deliveryId" : "bb380f84-5f21-4197-9df2-0639ba53264f",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bb380f84-5f21-4197-9df2-0639ba53264f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=bb380f84-5f21-4197-9df2-0639ba53264f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4c1"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=bb380f84-5f21-4197-9df2-0639ba53264f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bb380f84-5f21-4197-9df2-0639ba53264f/workflow"
        }
      }
    }, {
      "id" : "8716d43b-61e0-46bd-99df-b89557708345",
      "folderId" : "5cdf090146e0fb036233c4c0",
      "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-05-17T19:18:25.490Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.490Z",
      "deliveryId" : "8716d43b-61e0-46bd-99df-b89557708345",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8716d43b-61e0-46bd-99df-b89557708345"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8716d43b-61e0-46bd-99df-b89557708345",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4c0"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8716d43b-61e0-46bd-99df-b89557708345{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8716d43b-61e0-46bd-99df-b89557708345/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc/content-items?folderId=5cdf090146e0fb036233c4c0&folderId=5cdf090146e0fb036233c4c1&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc/content-items?folderId=5cdf090146e0fb036233c4c0&folderId=5cdf090146e0fb036233c4c1&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc/content-items?folderId=5cdf090146e0fb036233c4c0&folderId=5cdf090146e0fb036233c4c1&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4bc/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/5cdf090146e0fb036233c4c8/content-items?folderId=!5cdf090146e0fb036233c4cc HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "6fee1c6e-b958-476b-94aa-faf846a014ff",
      "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-05-17T19:18:25.981Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.981Z",
      "deliveryId" : "6fee1c6e-b958-476b-94aa-faf846a014ff",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6fee1c6e-b958-476b-94aa-faf846a014ff"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6fee1c6e-b958-476b-94aa-faf846a014ff",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6fee1c6e-b958-476b-94aa-faf846a014ff{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6fee1c6e-b958-476b-94aa-faf846a014ff/workflow"
        }
      }
    }, {
      "id" : "f956929a-f22c-43af-91a4-75fa04af9203",
      "folderId" : "5cdf090146e0fb036233c4cd",
      "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-05-17T19:18:25.947Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.947Z",
      "deliveryId" : "f956929a-f22c-43af-91a4-75fa04af9203",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f956929a-f22c-43af-91a4-75fa04af9203"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f956929a-f22c-43af-91a4-75fa04af9203",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4cd"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f956929a-f22c-43af-91a4-75fa04af9203{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f956929a-f22c-43af-91a4-75fa04af9203/workflow"
        }
      }
    }, {
      "id" : "b0dd8c92-5bfc-40b9-8f83-4af593059bb4",
      "folderId" : "5cdf090146e0fb036233c4cd",
      "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-05-17T19:18:25.915Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.915Z",
      "deliveryId" : "b0dd8c92-5bfc-40b9-8f83-4af593059bb4",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b0dd8c92-5bfc-40b9-8f83-4af593059bb4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b0dd8c92-5bfc-40b9-8f83-4af593059bb4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4cd"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b0dd8c92-5bfc-40b9-8f83-4af593059bb4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0dd8c92-5bfc-40b9-8f83-4af593059bb4/workflow"
        }
      }
    }, {
      "id" : "6d0d233c-ea80-471f-b0d5-f06196effd6e",
      "folderId" : "5cdf090146e0fb036233c4cd",
      "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-05-17T19:18:25.883Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:25.883Z",
      "deliveryId" : "6d0d233c-ea80-471f-b0d5-f06196effd6e",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6d0d233c-ea80-471f-b0d5-f06196effd6e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6d0d233c-ea80-471f-b0d5-f06196effd6e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5cdf090146e0fb036233c4cd"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6d0d233c-ea80-471f-b0d5-f06196effd6e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6d0d233c-ea80-471f-b0d5-f06196effd6e/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8/content-items?folderId=!5cdf090146e0fb036233c4cc&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8/content-items?folderId=!5cdf090146e0fb036233c4cc&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8/content-items?folderId=!5cdf090146e0fb036233c4cc&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090146e0fb036233c4c8/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/d601d632-debe-467d-bea2-b1b2515090cb/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-05-17T19:18:22.710Z",
        "historyEventId" : "0be4b4f8-ce1b-496b-9e54-c516d69a30ba"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7e128f7c-95f7-4297-941a-479eaf3c3a57",
        "createdDate" : "2019-05-07T19:18:22.720Z",
        "historyEventId" : "45a88152-7fa8-4daf-84ca-7249f76a07b1"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "1049b7b6-8d00-452b-916b-3e43fcb9504f",
        "createdDate" : "2019-05-06T19:18:22.720Z",
        "historyEventId" : "42ae188d-429b-4e46-9f15-b624e7835e7e"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "58860e27-eb8f-4126-b99a-59b79756ed3b",
        "createdDate" : "2019-05-05T19:18:22.720Z",
        "historyEventId" : "e824aaf7-58d6-4cb2-8d3c-13a2e5a18bf9"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "fb2e550f-f892-4897-abfc-3765d144a470",
        "createdDate" : "2019-05-04T19:18:22.720Z",
        "historyEventId" : "d30cfc7a-2be7-4215-b630-0c97d1f9a099"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ef3daaf3-22d0-45dc-aa29-91d6c72fc062",
        "createdDate" : "2019-05-03T19:18:22.720Z",
        "historyEventId" : "8b56de0d-b013-4c9b-b327-f26f0ff2c444"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.708Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.665Z",
        "historyEventId" : "b1a2296e-b68d-4a16-a127-a50d6c7cd8f3"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "382cc7e4-dfdc-4de9-be9b-e9afe62dbd37",
        "createdDate" : "2019-05-06T19:18:22.720Z",
        "historyEventId" : "89f11c59-76d1-4b94-a448-651be6727c93"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a6b2a86f-1294-4aa4-bd47-c364ab907dbc",
        "createdDate" : "2019-05-05T19:18:22.720Z",
        "historyEventId" : "0e89ccb5-d132-4dd9-8acb-1ad11de3cb81"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "116a77d3-c4d3-4a11-90e8-7ebe33797f4b",
        "createdDate" : "2019-05-04T19:18:22.720Z",
        "historyEventId" : "7e3e6986-1def-4bcf-902a-06814aeaf843"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "06eb91e4-3375-4b64-9043-767c74073d0f",
        "createdDate" : "2019-05-03T19:18:22.720Z",
        "historyEventId" : "75a00cb5-ae99-4ffd-a656-cef2e1fcf4c2"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c14f4984-8737-4ab4-9c32-cf03e835b4ed",
        "createdDate" : "2019-05-02T19:18:22.720Z",
        "historyEventId" : "94e6a430-66da-497c-bf06-0cbd785a859e"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.663Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.621Z",
        "historyEventId" : "e6e4b653-0f38-416d-9b80-ea283e2967e5"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "68fada26-4ded-4832-9cb3-ba9e2a69b98d",
        "createdDate" : "2019-05-05T19:18:22.720Z",
        "historyEventId" : "5ebca57a-e5a9-45b2-ab9d-886aa2d450c9"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9633d258-437d-4ea7-b6f8-6e083553c71a",
        "createdDate" : "2019-05-04T19:18:22.720Z",
        "historyEventId" : "29859d9d-b0dd-4ebc-99d1-fe3ef87c9419"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9e6e5505-1470-41f2-9d40-fcd09a27526d",
        "createdDate" : "2019-05-03T19:18:22.720Z",
        "historyEventId" : "1aa575c8-995b-4c12-ad7e-61a163226dd4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "01ecd114-d2a5-454d-a9fb-7512d32a0e8c",
        "createdDate" : "2019-05-02T19:18:22.720Z",
        "historyEventId" : "14b7f5bf-0452-4d65-b342-d279f2dc9506"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "f5b5b8df-01fc-410d-a13d-4735b9e991df",
        "createdDate" : "2019-05-01T19:18:22.720Z",
        "historyEventId" : "edbefb08-3057-4fb6-86ad-3ea3d9da6da9"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.620Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.577Z",
        "historyEventId" : "6c9ca3d4-0d2c-4f41-a9f2-9abe1e57f40b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "57bc3b17-00b0-4b9b-89fa-226932a09dca",
        "createdDate" : "2019-05-04T19:18:22.720Z",
        "historyEventId" : "731baf90-956f-47b0-8551-9b96bc059318"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "88d37689-490c-4ced-940d-073863a467cc",
        "createdDate" : "2019-05-03T19:18:22.720Z",
        "historyEventId" : "5816c27d-91d2-43f8-914a-e9b21b0b3271"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "9d02da26-15bc-4e53-b72a-9570a3a3b27d",
        "createdDate" : "2019-05-02T19:18:22.720Z",
        "historyEventId" : "272a2bc9-b68a-45de-aaeb-a0a6234b792a"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "cb81e431-22ae-4047-b6d2-c9214bd47f16",
        "createdDate" : "2019-05-01T19:18:22.720Z",
        "historyEventId" : "53c914f4-40d6-4496-a0c0-d7db0b2b8325"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "d7ca3978-81f3-4daf-a3ae-b2049c2dbb6e",
        "createdDate" : "2019-04-30T19:18:22.720Z",
        "historyEventId" : "c897f994-c20f-4a6f-a065-37d89c05c99e"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.576Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.533Z",
        "historyEventId" : "405f79dc-e053-441f-8239-35cb5099755d"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c73e117d-66e5-40fe-b25e-d723b628ef1c",
        "createdDate" : "2019-05-03T19:18:22.720Z",
        "historyEventId" : "08cde5cd-e5f2-4c43-8ad1-f83f4d059a8b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7a391886-3b57-4295-bc73-4f05abb8b141",
        "createdDate" : "2019-05-02T19:18:22.720Z",
        "historyEventId" : "776a656c-16fd-4ce0-8149-2436a148901b"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "07358b4f-a8d8-4650-b721-8445c2c432db",
        "createdDate" : "2019-05-01T19:18:22.720Z",
        "historyEventId" : "5eaf7d13-fb32-4257-87e8-c1bce001115d"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "9579d643-7d56-4d60-aeea-72afe689c1ea",
        "createdDate" : "2019-04-30T19:18:22.720Z",
        "historyEventId" : "1b316fc6-7064-44b0-9e49-6a88e43f4eb6"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "92da86a3-eb66-4aee-91d0-5dc9e275ed33",
        "createdDate" : "2019-04-29T19:18:22.720Z",
        "historyEventId" : "7d8af874-08dc-4ac7-bdde-e4a01990025f"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.532Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.489Z",
        "historyEventId" : "6bfc21ab-fe36-491a-87f4-76c2fc45a131"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a2ed4e93-d087-449e-b832-dd497cf7d0e3",
        "createdDate" : "2019-05-02T19:18:22.720Z",
        "historyEventId" : "1198e0b9-1d66-4e86-9d98-6c9342aada3e"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "11537f11-6503-4a9d-b66b-a093515518ab",
        "createdDate" : "2019-05-01T19:18:22.720Z",
        "historyEventId" : "5446ce91-6f68-4532-bfca-36f064d52694"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "a1709b80-2869-4945-8088-0ef856a14d86",
        "createdDate" : "2019-04-30T19:18:22.720Z",
        "historyEventId" : "86a2d870-f689-4dbf-a1b9-fbf64f884ba9"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "33c217f4-2bf5-4184-a1a0-b000d02e5c95",
        "createdDate" : "2019-04-29T19:18:22.720Z",
        "historyEventId" : "690ee817-388c-4f7a-b927-56a89a0539cf"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "f0dd9290-071c-49c0-b826-6a8a9d4f1362",
        "createdDate" : "2019-04-28T19:18:22.720Z",
        "historyEventId" : "f0f18a42-0aa0-44c2-85bc-dd2126e80406"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.487Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.444Z",
        "historyEventId" : "389c79a6-02dd-4d4d-9531-f5fc5b8a9bc7"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "5c8fcebd-2207-450f-8507-c190e071d2f7",
        "createdDate" : "2019-05-01T19:18:22.720Z",
        "historyEventId" : "700ccd11-6315-4ea2-b661-c9b73af81786"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "7e0f9f43-f77b-43d9-ab6e-b25fe0e85c22",
        "createdDate" : "2019-04-30T19:18:22.720Z",
        "historyEventId" : "cd6352aa-c62e-4e42-96e4-d929c8ec9495"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "c8b20b7c-4e6b-4952-84a5-6d4a1a91980a",
        "createdDate" : "2019-04-29T19:18:22.720Z",
        "historyEventId" : "747c8b13-eb58-4973-bdab-bf54c567ea81"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "71aa0ad2-7495-4024-b479-cf5c1968fc5d",
        "createdDate" : "2019-04-28T19:18:22.720Z",
        "historyEventId" : "158c0638-53d0-4910-adfe-d6c02d28cb7b"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.443Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.395Z",
        "historyEventId" : "47e34ab6-1ff7-40e2-8f3c-faef8ce2e2fb"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "edf1ba38-007e-4bb7-9b2b-bc6fe09a70ee",
        "createdDate" : "2019-04-30T19:18:22.720Z",
        "historyEventId" : "77ef21eb-9561-4e07-b34e-1f8e587a7332"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "4913ea22-d440-4fc6-8b7e-0c5f2951a333",
        "createdDate" : "2019-04-29T19:18:22.720Z",
        "historyEventId" : "86b4d396-97d0-408f-b3cf-1cc282d2e3c9"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ea7a8fcd-f9cb-47d5-8f61-4f870452238e",
        "createdDate" : "2019-04-28T19:18:22.720Z",
        "historyEventId" : "189d4a24-918c-45ca-8bff-08e6671efdfd"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.393Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.349Z",
        "historyEventId" : "adeb6efd-8a6d-4884-93b6-46bcb8ba6d4a"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "b6941c62-0104-4e27-99ec-a35528ce8f54",
        "createdDate" : "2019-04-29T19:18:22.720Z",
        "historyEventId" : "338d59b4-94c7-4c86-bbf6-e0dcfe600c9c"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a2312cf0-596b-48f3-9f00-d42df16bc5fb",
        "createdDate" : "2019-04-28T19:18:22.720Z",
        "historyEventId" : "617a0179-2716-4b5c-90f1-96d9212d11f8"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.348Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:18:22.307Z",
        "historyEventId" : "1c1c5f88-caa3-4e34-a3a3-57fc54b6f962"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "281e1199-da69-4ac7-a556-0794f63c7bcd",
        "createdDate" : "2019-04-28T19:18:22.720Z",
        "historyEventId" : "c8b37384-f7a2-494b-90a3-1f195c79cd12"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:22.306Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d601d632-debe-467d-bea2-b1b2515090cb/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/90ba697e-2101-4230-b352-0ab683f8a80b/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" : "23201800-ab6c-4267-9357-002c3efb30c9",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-17T19:18:58.751Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "7a0277a3-00f0-4535-9f70-ae49aeef533f",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-13T19:18:58.764Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "91e24d4b-77b7-4b83-9e3d-2057e94755a0",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-12T19:18:58.764Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "76059031-8411-4b18-95e3-741a3c38642a",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-11T19:18:58.764Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "6e277736-248d-4e2d-a389-a42b5014292e",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-10T19:18:58.764Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "86bb2e9f-9e39-4887-8e67-595dfb118a2d",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-09T19:18:58.764Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "ff9eee23-29e8-48a0-bc01-bd34fa9710fe",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-08T19:18:58.764Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "dd1b3238-7990-47ae-80c5-1afec6de3e6c",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-07T19:18:58.764Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "ebce9228-41f7-47af-b032-fed0aaa11ba4",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-06T19:18:58.764Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "58b12040-f2a2-4247-ad77-faf8a69e66b2",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-05T19:18:58.764Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "ec6a27b4-2884-4e65-aa0b-f952edf27441",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-04T19:18:58.764Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "d2d13102-dc18-46d8-998c-5bd226a722dc",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-03T19:18:58.764Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "d48ed2ad-41ed-43cb-9288-cf253dd4e973",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-02T19:18:58.764Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "69395c76-9fba-4bac-acc3-28ef8f0b3f2b",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-05-01T19:18:58.764Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "96beddc8-4c0c-4539-91d8-567bf094fa88",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-04-30T19:18:58.764Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "cc1902c3-0287-41ea-b433-e81bab574b83",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-04-29T19:18:58.764Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "7e1b217b-ad0a-495d-8849-3bf5898d87f0",
      "contentItemId" : "90ba697e-2101-4230-b352-0ab683f8a80b",
      "version" : 1,
      "createdDate" : "2019-04-28T19:18:58.764Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/90ba697e-2101-4230-b352-0ab683f8a80b/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/90ba697e-2101-4230-b352-0ab683f8a80b/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/90ba697e-2101-4230-b352-0ab683f8a80b/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/1e1c3dd4-269c-4d07-b36a-77d37775c978/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" : "1e1c3dd4-269c-4d07-b36a-77d37775c978",
      "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-05-17T19:18:21.888Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:21.940Z",
      "deliveryId" : "1e1c3dd4-269c-4d07-b36a-77d37775c978",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08fd46e0fb036233c308"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1e1c3dd4-269c-4d07-b36a-77d37775c978"
        }
      }
    }, {
      "id" : "1e1c3dd4-269c-4d07-b36a-77d37775c978",
      "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-05-17T19:18:21.888Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:21.940Z",
      "deliveryId" : "1e1c3dd4-269c-4d07-b36a-77d37775c978",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08fd46e0fb036233c308"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1e1c3dd4-269c-4d07-b36a-77d37775c978"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1e1c3dd4-269c-4d07-b36a-77d37775c978/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=d03e22b4-747d-4490-922d-b683f1e4d2d5 HTTP/1.1
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "d03e22b4-747d-4490-922d-b683f1e4d2d5",
      "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" : "336467bf-6744-4a14-8f20-57f39fe64d58"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:13.146Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:13.146Z",
      "deliveryId" : "d03e22b4-747d-4490-922d-b683f1e4d2d5",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/planned{?epoch,time}",
          "templated" : true
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d03e22b4-747d-4490-922d-b683f1e4d2d5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f446e0fb036233b7f3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d03e22b4-747d-4490-922d-b683f1e4d2d5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d03e22b4-747d-4490-922d-b683f1e4d2d5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5/workflow"
        }
      }
    }, {
      "id" : "336467bf-6744-4a14-8f20-57f39fe64d58",
      "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" : "9d6e2ff9-0887-4444-a3cb-bf39a44540fb"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:13.110Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:13.110Z",
      "deliveryId" : "336467bf-6744-4a14-8f20-57f39fe64d58",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/planned{?epoch,time}",
          "templated" : true
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=336467bf-6744-4a14-8f20-57f39fe64d58"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f446e0fb036233b7f3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=336467bf-6744-4a14-8f20-57f39fe64d58",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=336467bf-6744-4a14-8f20-57f39fe64d58{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/336467bf-6744-4a14-8f20-57f39fe64d58/workflow"
        }
      }
    }, {
      "id" : "9d6e2ff9-0887-4444-a3cb-bf39a44540fb",
      "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-05-17T19:18:13.071Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:13.071Z",
      "deliveryId" : "9d6e2ff9-0887-4444-a3cb-bf39a44540fb",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb{?projection}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9d6e2ff9-0887-4444-a3cb-bf39a44540fb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f446e0fb036233b7f3"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9d6e2ff9-0887-4444-a3cb-bf39a44540fb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9d6e2ff9-0887-4444-a3cb-bf39a44540fb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9d6e2ff9-0887-4444-a3cb-bf39a44540fb/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d03e22b4-747d-4490-922d-b683f1e4d2d5"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/d03e22b4-747d-4490-922d-b683f1e4d2d5{?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/4959e74e-59b4-4812-ae68-d47d542d51aa/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" : "4959e74e-59b4-4812-ae68-d47d542d51aa",
  "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-05-17T19:18:12.574Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:12.574Z",
  "deliveryId" : "4959e74e-59b4-4812-ae68-d47d542d51aa",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4959e74e-59b4-4812-ae68-d47d542d51aa/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f446e0fb036233b7a2"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4959e74e-59b4-4812-ae68-d47d542d51aa"
    }
  }
}

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/8af65492-0b45-4804-ba82-c0244f82dfe7/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" : "8af65492-0b45-4804-ba82-c0244f82dfe7",
  "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-05-17T19:18:11.930Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:12.086Z",
  "deliveryId" : "8af65492-0b45-4804-ba82-c0244f82dfe7",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8af65492-0b45-4804-ba82-c0244f82dfe7/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f346e0fb036233b751"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8af65492-0b45-4804-ba82-c0244f82dfe7"
    }
  }
}

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/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/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" : "1ddbb1b6-0cd3-4624-a821-31e35e8fe21e",
  "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-05-17T19:18:11.242Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:11.380Z",
  "deliveryId" : "1ddbb1b6-0cd3-4624-a821-31e35e8fe21e",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1ddbb1b6-0cd3-4624-a821-31e35e8fe21e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf08f246e0fb036233b701"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1ddbb1b6-0cd3-4624-a821-31e35e8fe21e"
    }
  }
}

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/57af5ba8-c8c1-41e4-b068-631adc36cf00/restore HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 43

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

Example response

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

{
  "id" : "57af5ba8-c8c1-41e4-b068-631adc36cf00",
  "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-05-17T19:18:44.681Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:44.798Z",
  "deliveryId" : "57af5ba8-c8c1-41e4-b068-631adc36cf00",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=57af5ba8-c8c1-41e4-b068-631adc36cf00"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf091446e0fb036233c749"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=57af5ba8-c8c1-41e4-b068-631adc36cf00",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=57af5ba8-c8c1-41e4-b068-631adc36cf00{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/57af5ba8-c8c1-41e4-b068-631adc36cf00/workflow"
    }
  }
}

Search Content Items by Text

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "03603838-2634-4bba-9f85-65c06040ccba",
      "contentRepositoryId" : "5cdf090846e0fb036233c5c8",
      "folderId" : null,
      "deliveryId" : "03603838-2634-4bba-9f85-65c06040ccba",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:18:33.928Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:18:33.928Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090846e0fb036233c5c8"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=03603838-2634-4bba-9f85-65c06040ccba",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=03603838-2634-4bba-9f85-65c06040ccba{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/03603838-2634-4bba-9f85-65c06040ccba/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090846e0fb036233c5c7/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090846e0fb036233c5c7/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090846e0fb036233c5c7/content-items/find?query=uniondusk&page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Faceting Content Items with Search by Text

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

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

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "id" : "1a915756-ed46-4fe5-bf49-af6ad9b60ccf",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "1a915756-ed46-4fe5-bf49-af6ad9b60ccf",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "324c45c7-21f8-4e8f-8b52-32913102171b",
      "createdBy" : "user",
      "createdDate" : "2019-04-18T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-18T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1a915756-ed46-4fe5-bf49-af6ad9b60ccf",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1a915756-ed46-4fe5-bf49-af6ad9b60ccf{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1a915756-ed46-4fe5-bf49-af6ad9b60ccf/workflow"
        }
      }
    }, {
      "id" : "2fe96ff6-ad35-49cf-9632-0b90b09279e5",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "2fe96ff6-ad35-49cf-9632-0b90b09279e5",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "eb7694dd-0481-4180-8b46-d9d713e4d0e4",
      "createdBy" : "user",
      "createdDate" : "2019-04-19T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-19T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2fe96ff6-ad35-49cf-9632-0b90b09279e5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2fe96ff6-ad35-49cf-9632-0b90b09279e5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fe96ff6-ad35-49cf-9632-0b90b09279e5/workflow"
        }
      }
    }, {
      "id" : "fbf92171-dc1a-4b25-9116-b4f2e52c91d4",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "fbf92171-dc1a-4b25-9116-b4f2e52c91d4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "911a331d-30bb-4891-a8a9-7ba661729887",
      "createdBy" : "user",
      "createdDate" : "2019-04-20T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-20T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fbf92171-dc1a-4b25-9116-b4f2e52c91d4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fbf92171-dc1a-4b25-9116-b4f2e52c91d4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fbf92171-dc1a-4b25-9116-b4f2e52c91d4/workflow"
        }
      }
    }, {
      "id" : "b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "6b83464c-0005-48ea-b26d-976d2f10e382",
      "createdBy" : "user",
      "createdDate" : "2019-04-21T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-21T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3e2946c-76cb-4aa0-81ef-ceff59f0a8ca/workflow"
        }
      }
    }, {
      "id" : "c4299a17-84a6-4af0-b3ed-d23b24c4af58",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "c4299a17-84a6-4af0-b3ed-d23b24c4af58",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "601e0ee2-e14f-4c30-93e0-b400cce1b709",
      "createdBy" : "user",
      "createdDate" : "2019-04-22T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-22T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c4299a17-84a6-4af0-b3ed-d23b24c4af58",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c4299a17-84a6-4af0-b3ed-d23b24c4af58{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4299a17-84a6-4af0-b3ed-d23b24c4af58/workflow"
        }
      }
    }, {
      "id" : "41b63889-78eb-4d79-a810-274360db0a8c",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "41b63889-78eb-4d79-a810-274360db0a8c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "13a00684-dffa-4696-82c1-b0d95b873683",
      "createdBy" : "user",
      "createdDate" : "2019-04-23T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-23T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=41b63889-78eb-4d79-a810-274360db0a8c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=41b63889-78eb-4d79-a810-274360db0a8c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/41b63889-78eb-4d79-a810-274360db0a8c/workflow"
        }
      }
    }, {
      "id" : "d59e1032-a349-485f-8a28-cecdb478a8cd",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "d59e1032-a349-485f-8a28-cecdb478a8cd",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "ec9ae16d-523f-458e-8b82-610b843cbf96",
      "createdBy" : "user",
      "createdDate" : "2019-04-24T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-24T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d59e1032-a349-485f-8a28-cecdb478a8cd",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d59e1032-a349-485f-8a28-cecdb478a8cd{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d59e1032-a349-485f-8a28-cecdb478a8cd/workflow"
        }
      }
    }, {
      "id" : "cc1b6921-9df1-4843-a36d-6624c418e132",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "cc1b6921-9df1-4843-a36d-6624c418e132",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "59cff3e4-af54-4cd3-86cd-6e8d7d70c488",
      "createdBy" : "user",
      "createdDate" : "2019-04-25T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-25T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cc1b6921-9df1-4843-a36d-6624c418e132",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cc1b6921-9df1-4843-a36d-6624c418e132{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cc1b6921-9df1-4843-a36d-6624c418e132/workflow"
        }
      }
    }, {
      "id" : "d2a4102e-f606-40c7-a5a9-5be1e897da17",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "d2a4102e-f606-40c7-a5a9-5be1e897da17",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "78f1e92a-229e-4bf1-98cc-22bd9444fd1d",
      "createdBy" : "user",
      "createdDate" : "2019-04-26T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-26T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d2a4102e-f606-40c7-a5a9-5be1e897da17",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d2a4102e-f606-40c7-a5a9-5be1e897da17{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d2a4102e-f606-40c7-a5a9-5be1e897da17/workflow"
        }
      }
    }, {
      "id" : "224d009d-d86f-4135-8be2-13ed16be703e",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "224d009d-d86f-4135-8be2-13ed16be703e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "572ffdb9-af57-4406-9987-d8d3d4896006",
      "createdBy" : "user",
      "createdDate" : "2019-04-27T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-27T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=224d009d-d86f-4135-8be2-13ed16be703e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=224d009d-d86f-4135-8be2-13ed16be703e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/224d009d-d86f-4135-8be2-13ed16be703e/workflow"
        }
      }
    }, {
      "id" : "8f89b5f1-ce2a-4ff9-adab-35f50682627d",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "8f89b5f1-ce2a-4ff9-adab-35f50682627d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "620c8fe8-193d-450c-851e-1556964cdbaa",
      "createdBy" : "user",
      "createdDate" : "2019-04-28T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-28T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8f89b5f1-ce2a-4ff9-adab-35f50682627d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8f89b5f1-ce2a-4ff9-adab-35f50682627d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8f89b5f1-ce2a-4ff9-adab-35f50682627d/workflow"
        }
      }
    }, {
      "id" : "fc985ba1-e72f-448f-9356-f5bea78fe1e0",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "fc985ba1-e72f-448f-9356-f5bea78fe1e0",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "49a8b5bd-881f-4a69-b381-17bbff764e41",
      "createdBy" : "user",
      "createdDate" : "2019-04-29T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-29T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fc985ba1-e72f-448f-9356-f5bea78fe1e0",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fc985ba1-e72f-448f-9356-f5bea78fe1e0{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc985ba1-e72f-448f-9356-f5bea78fe1e0/workflow"
        }
      }
    }, {
      "id" : "982a630a-5865-498a-83ae-7f04e37fe9d9",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "982a630a-5865-498a-83ae-7f04e37fe9d9",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "98615895-ce24-4685-8556-d0ab27c14116",
      "createdBy" : "user",
      "createdDate" : "2019-04-30T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-04-30T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=982a630a-5865-498a-83ae-7f04e37fe9d9",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=982a630a-5865-498a-83ae-7f04e37fe9d9{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/982a630a-5865-498a-83ae-7f04e37fe9d9/workflow"
        }
      }
    }, {
      "id" : "259afba6-2a15-44e8-906c-465b315567c6",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "259afba6-2a15-44e8-906c-465b315567c6",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "c304d2f8-c87e-48f1-b326-b0217ada1ba7",
      "createdBy" : "user",
      "createdDate" : "2019-05-01T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-01T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=259afba6-2a15-44e8-906c-465b315567c6",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=259afba6-2a15-44e8-906c-465b315567c6{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/259afba6-2a15-44e8-906c-465b315567c6/workflow"
        }
      }
    }, {
      "id" : "5afdd399-51e9-41ee-90b6-2211b9f9b3d7",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "5afdd399-51e9-41ee-90b6-2211b9f9b3d7",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1181a09a-5a6c-4b11-bd18-e31f338f0be3",
      "createdBy" : "user",
      "createdDate" : "2019-05-02T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-02T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5afdd399-51e9-41ee-90b6-2211b9f9b3d7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5afdd399-51e9-41ee-90b6-2211b9f9b3d7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5afdd399-51e9-41ee-90b6-2211b9f9b3d7/workflow"
        }
      }
    }, {
      "id" : "1f89f74c-167c-490f-9cf8-79ddc00c2ffb",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "1f89f74c-167c-490f-9cf8-79ddc00c2ffb",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "0037b42d-f1d6-4157-b92d-8eaefaae731d",
      "createdBy" : "user",
      "createdDate" : "2019-05-03T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-03T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1f89f74c-167c-490f-9cf8-79ddc00c2ffb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1f89f74c-167c-490f-9cf8-79ddc00c2ffb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1f89f74c-167c-490f-9cf8-79ddc00c2ffb/workflow"
        }
      }
    }, {
      "id" : "a2f0b53c-434d-49f9-9253-beb90f378c24",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "a2f0b53c-434d-49f9-9253-beb90f378c24",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "918942e1-b6d9-489e-a935-d52513b65fed",
      "createdBy" : "user",
      "createdDate" : "2019-05-04T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-04T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a2f0b53c-434d-49f9-9253-beb90f378c24",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a2f0b53c-434d-49f9-9253-beb90f378c24{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a2f0b53c-434d-49f9-9253-beb90f378c24/workflow"
        }
      }
    }, {
      "id" : "d7e1f211-702f-4e01-bec5-b7f14da277a4",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "d7e1f211-702f-4e01-bec5-b7f14da277a4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "a99b1b71-a236-4388-b600-260cf6c95650",
      "createdBy" : "user",
      "createdDate" : "2019-05-05T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-05T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d7e1f211-702f-4e01-bec5-b7f14da277a4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d7e1f211-702f-4e01-bec5-b7f14da277a4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d7e1f211-702f-4e01-bec5-b7f14da277a4/workflow"
        }
      }
    }, {
      "id" : "58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "32994429-d5c7-4279-b184-d5e994c782e1",
      "createdBy" : "user",
      "createdDate" : "2019-05-06T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-06T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58281ac5-c9cb-4c1a-a7b1-e0c2db7079b4/workflow"
        }
      }
    }, {
      "id" : "ca4915af-f026-4f92-a42f-37dcae6492f2",
      "contentRepositoryId" : "5cdf090d46e0fb036233c61c",
      "folderId" : null,
      "deliveryId" : "ca4915af-f026-4f92-a42f-37dcae6492f2",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "e6f5ac2e-c0fe-41b2-8829-3993ac94514c",
      "createdBy" : "user",
      "createdDate" : "2019-05-07T19:18:37.566Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-07T19:18:37.566Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090d46e0fb036233c61c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ca4915af-f026-4f92-a42f-37dcae6492f2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ca4915af-f026-4f92-a42f-37dcae6492f2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca4915af-f026-4f92-a42f-37dcae6492f2/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090d46e0fb036233c616/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090d46e0fb036233c616/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090d46e0fb036233c616/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf090d46e0fb036233c616/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 30,
    "totalPages" : 2,
    "number" : 0
  },
  "_facets" : {
    "schema" : [ {
      "_id" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "count" : 30
    } ],
    "-30 days" : [ {
      "_id" : "-29:DAYS,NOW",
      "count" : 30
    } ],
    "publishingStatus" : [ {
      "_id" : "NONE",
      "count" : 30
    } ]
  }
}

Text Search Query Syntax

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

Table 2. Reserved Search Characters
Description Symbol

Negation Operator

-

Field Search Operator

:

Quote (for exact search)

"

Comma (list multiple search terms)

,

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

Table 3. Text Search Examples
Query Meaning

apple

Find all content items containing the word "apple"

apple orange

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

apple,orange

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

apple -orange

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

-apple-orange

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

label:apple

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

"apple:orange"

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

apple label:orange

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

Publish Content Item

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

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/content-items/829d0118-2314-438b-897f-3f1c788902e4/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/5cdf091f46e0fb036233c7a1

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/54a223a5-cd7d-4720-85db-7a85c62df8f3/edition-slot-associations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "contentItemId" : "54a223a5-cd7d-4720-85db-7a85c62df8f3",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5cdf08ff46e0fb036233c3fd",
    "eventStart" : "2019-05-17T19:18:23.293Z",
    "eventEnd" : "2019-06-17T19:18:23.293Z",
    "editionTitle" : "Test",
    "editionId" : "5cdf08ff46e0fb036233c3fe",
    "editionStart" : "2019-05-17T19:18:23.293Z",
    "editionEnd" : "2019-06-17T19:18:23.293Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5cdf08ff46e0fb036233c403",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2019-05-17T19:18:23.948Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-05-17T19:18:23.887Z",
    "snapshotId" : "5cdf08ff46e0fb036233c409",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5cdf08ff46e0fb036233c3fe/slots/5cdf08ff46e0fb036233c403"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5cdf08ff46e0fb036233c3fe/slots/5cdf08ff46e0fb036233c403/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/54a223a5-cd7d-4720-85db-7a85c62df8f3/edition-slot-associations"
    }
  }
}

Localization

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

Assigning a workflow

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

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

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

Example response

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

{
  "id" : "7c5d230c-5568-4232-98f6-59fc09fa2431",
  "workflow" : {
    "state" : "5cdf096f46e0fb036233de0e"
  },
  "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-05-17T19:20:15.962Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:16.003Z",
  "deliveryId" : "7c5d230c-5568-4232-98f6-59fc09fa2431",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7c5d230c-5568-4232-98f6-59fc09fa2431"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf096f46e0fb036233de0c"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7c5d230c-5568-4232-98f6-59fc09fa2431",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7c5d230c-5568-4232-98f6-59fc09fa2431{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c5d230c-5568-4232-98f6-59fc09fa2431/workflow"
    }
  }
}

for more information on workflows see Workflows

Events

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

An Event contains a collection of Editions.

Creating a new Event

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - CREATE_EVENT

Example request

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

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

Example response

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

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

Get an Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Get an Event with Editions

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096846e0fb036233d532",
      "name" : "January Sale",
      "comment" : "This is an event.",
      "start" : "2017-01-01T00:00:00.000Z",
      "end" : "2017-01-01T23:59:59.000Z",
      "brief" : "http://external.doc/mybrief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096746e0fb036233d531"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d532/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096746e0fb036233d531/events?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096746e0fb036233d531/events?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096746e0fb036233d531/events?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096746e0fb036233d531/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/5cdf096846e0fb036233d57d HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 133

{
  "name" : "shoes",
  "start" : "2019-05-17T20:20:08.146Z",
  "end" : "2019-05-17T23:20:08.146Z",
  "brief" : "http://test/path2"
}

Example response

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

{
  "id" : "5cdf096846e0fb036233d57d",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-05-17T20:20:08.146Z",
  "end" : "2019-05-17T23:20:08.146Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d57c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d57d/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Delete an Event

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - DELETE_EVENT

Example request

DELETE /v2/content/events/5cdf096846e0fb036233d5c7 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=5cdf096846e0fb036233d610&rangeEnd=2019-05-20T19:20:08.388Z&rangeStart=2019-05-14T19:20:08.388Z&bounded=0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 7945

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096846e0fb036233d618",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-05-11T19:20:08.388Z",
      "end" : "2019-05-14T19:20:08.388Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d610"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d618/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096846e0fb036233d616",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-05-11T19:20:08.388Z",
      "end" : "2019-05-15T19:20:08.388Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d610"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d616/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096846e0fb036233d614",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-05-17T19:20:08.388Z",
      "end" : "2019-05-19T19:20:08.388Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d610"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d614/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096846e0fb036233d615",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-05-19T19:20:08.388Z",
      "end" : "2019-05-23T19:20:08.388Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d610"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d615/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096846e0fb036233d617",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-05-20T19:20:08.388Z",
      "end" : "2019-05-23T19:20:08.388Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d610"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d617/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096846e0fb036233d610&rangeStart=2019-05-14T19:20:08.388Z&rangeEnd=2019-05-20T19:20:08.388Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096846e0fb036233d610&rangeStart=2019-05-14T19:20:08.388Z&rangeEnd=2019-05-20T19:20:08.388Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096846e0fb036233d610&rangeStart=2019-05-14T19:20:08.388Z&rangeEnd=2019-05-20T19:20:08.388Z&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=5cdf096e46e0fb036233dd12&rangeEnd=2019-05-20T19:20:14.779Z&rangeStart=2019-05-14T19:20:14.779Z&bounded=0&projection=withEditions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3150

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096e46e0fb036233dd13",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-05-18T19:20:14.779Z",
      "end" : "2019-05-19T19:20:14.779Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5cdf096e46e0fb036233dd14",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-05-18T19:20:14.779Z",
        "end" : "2019-05-19T19:20:14.779Z",
        "eventId" : "5cdf096e46e0fb036233dd13",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:14.903Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:14.904Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:14.904Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096e46e0fb036233dd12"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd13/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096e46e0fb036233dd12&rangeStart=2019-05-14T19:20:14.779Z&rangeEnd=2019-05-20T19:20:14.779Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096e46e0fb036233dd12&rangeStart=2019-05-14T19:20:14.779Z&rangeEnd=2019-05-20T19:20:14.779Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096e46e0fb036233dd12&rangeStart=2019-05-14T19:20:14.779Z&rangeEnd=2019-05-20T19:20:14.779Z&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=5cdf096f46e0fb036233dd19&rangeStart=2019-05-17T19:20:15.046Z&bounded=0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 5053

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096f46e0fb036233dd1d",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-05-15T19:20:15.046Z",
      "end" : "2019-05-19T19:20:15.046Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd19"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1d/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096f46e0fb036233dd1c",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-05-17T19:20:15.046Z",
      "end" : "2019-05-19T19:20:15.046Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd19"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1c/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096f46e0fb036233dd1b",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-05-18T19:20:15.046Z",
      "end" : "2019-05-19T19:20:15.046Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd19"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd1b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd19&rangeStart=2019-05-17T19:20:15.046Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd19&rangeStart=2019-05-17T19:20:15.046Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd19&rangeStart=2019-05-17T19:20:15.046Z&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=5cdf096f46e0fb036233dd20&rangeEnd=2019-05-16T23:59:59.999Z&rangeStart=2017-01-01T00:00:00.000Z&bounded=1&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2349

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096f46e0fb036233dd24",
      "name" : "Yesterday",
      "comment" : "This is an event.",
      "start" : "2019-05-16T00:00:00.000Z",
      "end" : "2019-05-16T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd20"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd24/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-05-16T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-05-16T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2017-01-01T00:00:00.000Z&rangeEnd=2019-05-16T23: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=5cdf096f46e0fb036233dd20&rangeEnd=2019-05-17T23:59:59.999Z&rangeStart=2019-05-17T00:00:00.000Z&bounded=0&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2596

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096f46e0fb036233dd28",
      "name" : "Yesterday to Today",
      "comment" : "This is an event.",
      "start" : "2019-05-16T00:00:00.000Z",
      "end" : "2019-05-17T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd20"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd28/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-17T00:00:00.000Z&rangeEnd=2019-05-17T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-17T00:00:00.000Z&rangeEnd=2019-05-17T23:59:59.999Z&bounded=false&page=0&size=1"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-17T00:00:00.000Z&rangeEnd=2019-05-17T23:59:59.999Z&bounded=false&page=1&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-17T00:00:00.000Z&rangeEnd=2019-05-17T23: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=5cdf096f46e0fb036233dd20&rangeEnd=2019-05-18T23:59:59.999Z&rangeStart=2019-05-18T00:00:00.000Z&bounded=1&size=1 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2348

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096f46e0fb036233dd26",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-05-18T00:00:00.000Z",
      "end" : "2019-05-18T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096f46e0fb036233dd20"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096f46e0fb036233dd26/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-18T00:00:00.000Z&rangeEnd=2019-05-18T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-18T00:00:00.000Z&rangeEnd=2019-05-18T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5cdf096f46e0fb036233dd20&rangeStart=2019-05-18T00:00:00.000Z&rangeEnd=2019-05-18T23: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=5cdf096e46e0fb036233dd01&rangeEnd=2019-05-20T19:20:14.550Z&rangeStart=2019-05-14T19:20:14.550Z&bounded=0&slots=25e93a0d-e458-4887-9e68-cf1913272d0c&locales=en-GB HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2563

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096e46e0fb036233dd05",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-05-17T19:20:14.550Z",
      "end" : "2019-05-19T19:20:14.550Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096e46e0fb036233dd01"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096e46e0fb036233dd05/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096e46e0fb036233dd01&rangeStart=2019-05-14T19:20:14.550Z&rangeEnd=2019-05-20T19:20:14.550Z&bounded=false&slots=25e93a0d-e458-4887-9e68-cf1913272d0c&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096e46e0fb036233dd01&rangeStart=2019-05-14T19:20:14.550Z&rangeEnd=2019-05-20T19:20:14.550Z&bounded=false&slots=25e93a0d-e458-4887-9e68-cf1913272d0c&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096e46e0fb036233dd01&rangeStart=2019-05-14T19:20:14.550Z&rangeEnd=2019-05-20T19:20:14.550Z&bounded=false&slots=25e93a0d-e458-4887-9e68-cf1913272d0c&locales=en-GB&page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/events/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}
With Edition Projection

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

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096846e0fb036233d61b&rangeEnd=2019-05-20T19:20:08.622Z&rangeStart=2019-05-14T19:20:08.622Z&bounded=0&projection=withEditions&slots=de7333bd-2a51-465d-be10-527265834fa2&size=50 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 40630

{
  "_embedded" : {
    "events" : [ {
      "id" : "5cdf096846e0fb036233d621",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-05-17T19:20:08.622Z",
      "end" : "2019-05-19T19:20:08.622Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5cdf096846e0fb036233d622",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.760Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.760Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.780Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d624",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.793Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.793Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.816Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d627",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.827Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.827Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.850Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d62b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.862Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.863Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.887Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d630",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.899Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.899Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.926Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d636",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.936Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.937Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:08.961Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096846e0fb036233d63d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:08.973Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:08.974Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.006Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d645",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.016Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.017Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.044Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d64e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.055Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.055Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.083Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d658",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.095Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.096Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.126Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d663",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.137Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.137Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.169Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d66f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.182Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.182Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.212Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d67c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.221Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.221Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.253Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d68a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.264Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.264Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.296Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d699",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.307Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.307Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.342Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d6a9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.353Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.353Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.389Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d6ba",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.400Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.400Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.453Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d6cc",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.464Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.465Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.509Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d6df",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.520Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.520Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.559Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d6f3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.574Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.574Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.619Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d708",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.632Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.632Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.675Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d71e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.687Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.687Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:09.731Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096946e0fb036233d735",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:09.742Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:09.742Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.362Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d74d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.377Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.377Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.435Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d766",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.446Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.447Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.484Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d780",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.495Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.495Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.538Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d79b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.549Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.549Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.594Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d7b7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.605Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.605Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.657Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d7d4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.669Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.669Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.721Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d7f2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.733Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.733Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.791Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d811",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.805Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.806Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.850Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d831",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.860Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.860Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.907Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d852",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.918Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.919Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:10.968Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096a46e0fb036233d874",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:10.980Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:10.980Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.035Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d897",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.046Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.047Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.099Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d8bb",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.110Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.111Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.161Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d8e0",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.172Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.172Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.225Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d906",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.236Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.236Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.287Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d92d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.297Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.298Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.363Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d955",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.374Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.374Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.437Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d97e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.447Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.448Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.504Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d9a8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.515Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.516Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.576Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d9d3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.588Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.589Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.648Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233d9ff",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.658Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.659Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.716Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233da2c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.726Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.727Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.783Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233da5a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.795Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.795Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.854Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233da89",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.864Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.865Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:11.928Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096b46e0fb036233dab9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:11.939Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:11.940Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:12.006Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096c46e0fb036233daea",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:12.017Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:12.018Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:12.084Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5cdf096c46e0fb036233db1c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-05-17T19:20:08.622Z",
        "end" : "2019-05-19T19:20:08.622Z",
        "eventId" : "5cdf096846e0fb036233d621",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-05-17T19:20:12.098Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-05-17T19:20:12.099Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-05-17T19:20:12.172Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096846e0fb036233d61b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf096846e0fb036233d621/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096846e0fb036233d61b&rangeStart=2019-05-14T19:20:08.622Z&rangeEnd=2019-05-20T19:20:08.622Z&bounded=false&slots=de7333bd-2a51-465d-be10-527265834fa2&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096846e0fb036233d61b&rangeStart=2019-05-14T19:20:08.622Z&rangeEnd=2019-05-20T19:20:08.622Z&bounded=false&slots=de7333bd-2a51-465d-be10-527265834fa2&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5cdf096846e0fb036233d61b&rangeStart=2019-05-14T19:20:08.622Z&rangeEnd=2019-05-20T19:20:08.622Z&bounded=false&slots=de7333bd-2a51-465d-be10-527265834fa2&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/5cdf096846e0fb036233d532/editions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 179

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

Example response

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

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

{
  "name" : "Test",
  "start" : "2019-05-17T19:18:23.293Z",
  "end" : "2019-06-17T19:18:23.293Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

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

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

{
  "name" : "New Name",
  "start" : "2019-05-17T19:18:23.293Z",
  "end" : "2019-05-23T19:18:23.293Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

{
  "id" : "5cdf095346e0fb036233d051",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-05-17T19:18:23.293Z",
  "end" : "2019-05-23T19:18:23.293Z",
  "eventId" : "5cdf095346e0fb036233d050",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-05-17T19:19:47.129Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:19:47.130Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:19:47.150Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5cdf095346e0fb036233d050"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d051/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/5cdf095246e0fb036233cfbb 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/5cdf093d46e0fb036233cc14/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-05-17T19:19:26.366Z"
}

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

{
  "lastModifiedDate" : "2019-05-17T19:19:42.888Z",
  "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" : "5cdf094e46e0fb036233cd48"
}

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/5cdf094f46e0fb036233cd9e/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" : "5cdf094f46e0fb036233cda9"
}

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/5cdf095046e0fb036233cdff/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/5cdf095046e0fb036233ce54/editions/search HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

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

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/editions/search/findByEvent?eventId=5cdf095046e0fb036233ce54 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" : "5cdf095046e0fb036233ce56",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-05-17T19:18:23.293Z",
      "end" : "2019-05-17T21:18:23.293Z",
      "eventId" : "5cdf095046e0fb036233ce54",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-05-17T19:19:44.631Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:19:44.632Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:19:44.632Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf095046e0fb036233ce54"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce56/slot-collisions"
        }
      }
    }, {
      "id" : "5cdf095046e0fb036233ce55",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-05-17T20:18:23.293Z",
      "end" : "2019-05-17T21:18:23.293Z",
      "eventId" : "5cdf095046e0fb036233ce54",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-05-17T19:19:44.616Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:19:44.617Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:19:44.617Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf095046e0fb036233ce54"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce55/slot-collisions"
        }
      }
    }, {
      "id" : "5cdf095046e0fb036233ce57",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-05-17T20:18:24.293Z",
      "end" : "2019-05-17T21:18:23.293Z",
      "eventId" : "5cdf095046e0fb036233ce54",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-05-17T19:19:44.647Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:19:44.647Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:19:44.647Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5cdf095046e0fb036233ce54"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095046e0fb036233ce57/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5cdf095046e0fb036233ce54&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5cdf095046e0fb036233ce54&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5cdf095046e0fb036233ce54&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/5cdf095246e0fb036233cf0f/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" : "a9558a88-05e5-4b18-aa92-c1b3bcb08924",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf0f/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf0f"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf0f/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/5cdf095246e0fb036233cf6b/conflicts/findByIdAndVersion?id=3e228d0d-5221-4b7f-856b-5b5ec9fb530d&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" : "5cdf095246e0fb036233cf6b",
  "contentItemId" : "3e228d0d-5221-4b7f-856b-5b5ec9fb530d",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5cdf095246e0fb036233cf6c",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:19:46.679Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5cdf095246e0fb036233cf6e",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "3e228d0d-5221-4b7f-856b-5b5ec9fb530d",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf6b/conflicts/findByIdAndVersion?id=3e228d0d-5221-4b7f-856b-5b5ec9fb530d&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf6b"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095246e0fb036233cf6b/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/5cdf095146e0fb036233cea9/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-05-17T19:19:45.456Z",
  "resolutions" : [ {
    "contentItemId" : "d9e7be91-e958-4cfe-baa7-6c0ee8f4c3b1",
    "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/5cdf092d46e0fb036233caf5/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" : "5cdf092d46e0fb036233caf5",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-05-17T19:18:23.293Z",
    "endDateTime" : "2019-06-17T19:18:23.293Z",
    "editionId" : "5cdf092d46e0fb036233caf0",
    "collidingSlotIds" : [ "2d8f77e1-c4ee-4a97-8702-5ba4e4e94c9a", "c3387763-7f7f-4497-97b1-d746476ee457" ],
    "eventName" : "Test",
    "eventId" : "5cdf092d46e0fb036233caef"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf092d46e0fb036233caf5/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf092d46e0fb036233caf5/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/5cdf095446e0fb036233d14a/slots?sourceEditionSlotId=5cdf095446e0fb036233d148 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5cdf095446e0fb036233d148

Example response

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

{
  "id" : "5cdf095446e0fb036233d14b",
  "eventId" : "5cdf095446e0fb036233d149",
  "editionId" : "5cdf095446e0fb036233d14a",
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:19:48.432Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:19:48.432Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5cdf095446e0fb036233d140",
  "slotId" : "496932c9-9149-40b2-94de-d9c7a3c5bc7b",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095446e0fb036233d14a/slots/5cdf095446e0fb036233d14b"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095446e0fb036233d14a/slots/5cdf095446e0fb036233d14b"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095446e0fb036233d14a"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/496932c9-9149-40b2-94de-d9c7a3c5bc7b{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095446e0fb036233d14a/slots/5cdf095446e0fb036233d14b/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095446e0fb036233d14a/slots/5cdf095446e0fb036233d14b/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Slots

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

Example Slot Content Type

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

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

Creating a Slot Repository

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

Creating a Slot

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

Auth rules

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

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request

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

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Fri, 17 May 2019 19:20:03 GMT
Location: https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "7ee3c764-b4c2-44c1-a28e-0a974023b669",
  "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-05-17T19:20:03.450Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:03.450Z",
  "deliveryId" : "7ee3c764-b4c2-44c1-a28e-0a974023b669",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7ee3c764-b4c2-44c1-a28e-0a974023b669"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf096346e0fb036233d206"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7ee3c764-b4c2-44c1-a28e-0a974023b669",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7ee3c764-b4c2-44c1-a28e-0a974023b669{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669/workflow"
    }
  }
}

Associating Slots to Editions

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

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

  • A Slot can be associated with multiple Editions.

  • A Slot can only be associated to an Edition once

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

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

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

[ {
  "slot" : "c045309f-1687-40ac-8cf6-128957c4eaf6"
}, {
  "slot" : "47e8cd77-c60c-4e1f-adf6-84766bb13499"
}, {
  "slot" : "f75aa24c-eeec-4e22-b2ac-fda51e900bb1"
} ]

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

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5cdf096446e0fb036233d274",
      "eventId" : "5cdf096446e0fb036233d26e",
      "editionId" : "5cdf096446e0fb036233d26f",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:20:04.407Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:20:04.407Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096446e0fb036233d26d",
      "slotId" : "c045309f-1687-40ac-8cf6-128957c4eaf6",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d274"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d274"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c045309f-1687-40ac-8cf6-128957c4eaf6{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d274/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d274/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096446e0fb036233d275",
      "eventId" : "5cdf096446e0fb036233d26e",
      "editionId" : "5cdf096446e0fb036233d26f",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:20:04.408Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:20:04.408Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096446e0fb036233d26d",
      "slotId" : "47e8cd77-c60c-4e1f-adf6-84766bb13499",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d275"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d275"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/47e8cd77-c60c-4e1f-adf6-84766bb13499{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d275/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d275/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096446e0fb036233d273",
      "eventId" : "5cdf096446e0fb036233d26e",
      "editionId" : "5cdf096446e0fb036233d26f",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:20:04.406Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:20:04.406Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096446e0fb036233d26d",
      "slotId" : "f75aa24c-eeec-4e22-b2ac-fda51e900bb1",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d273"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d273"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f75aa24c-eeec-4e22-b2ac-fda51e900bb1{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d273/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots/5cdf096446e0fb036233d273/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096446e0fb036233d26f/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/5cdf096346e0fb036233d263/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 6076

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5cdf096446e0fb036233d269",
      "eventId" : "5cdf096346e0fb036233d262",
      "editionId" : "5cdf096346e0fb036233d263",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:04.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:04.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096346e0fb036233d261",
      "slotId" : "413b870e-d212-41cd-86d5-ebe986b1a6f8",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d269"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d269"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/413b870e-d212-41cd-86d5-ebe986b1a6f8{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d269/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d269/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096446e0fb036233d267",
      "eventId" : "5cdf096346e0fb036233d262",
      "editionId" : "5cdf096346e0fb036233d263",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:03.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:03.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096346e0fb036233d261",
      "slotId" : "fcbd50a2-8af7-4b50-90b5-c7734c475819",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d267"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d267"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fcbd50a2-8af7-4b50-90b5-c7734c475819{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d267/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d267/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf096446e0fb036233d265",
      "eventId" : "5cdf096346e0fb036233d262",
      "editionId" : "5cdf096346e0fb036233d263",
      "createdBy" : "user",
      "createdDate" : "2017-06-05T04:03:02.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2017-06-05T04:03:02.000Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf096346e0fb036233d261",
      "slotId" : "f607081e-1a0a-468c-9d05-2861cd351e7e",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d265"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d265"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f607081e-1a0a-468c-9d05-2861cd351e7e{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d265/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots/5cdf096446e0fb036233d265/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d263/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/5cdf095346e0fb036233d0a2/slots?includedSlots=5db421cd-0761-449c-bd2b-04cf7f92038c HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2553

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5cdf095346e0fb036233d0a4",
      "eventId" : "5cdf095346e0fb036233d09e",
      "editionId" : "5cdf095346e0fb036233d0a2",
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:19:47.547Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-05-17T19:19:47.547Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5cdf095346e0fb036233d09d",
      "slotId" : "5db421cd-0761-449c-bd2b-04cf7f92038c",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots/5cdf095346e0fb036233d0a4"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots/5cdf095346e0fb036233d0a4"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5db421cd-0761-449c-bd2b-04cf7f92038c{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots/5cdf095346e0fb036233d0a4/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots/5cdf095346e0fb036233d0a4/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots?includedSlots=5db421cd-0761-449c-bd2b-04cf7f92038c&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots?includedSlots=5db421cd-0761-449c-bd2b-04cf7f92038c&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0a2/slots?includedSlots=5db421cd-0761-449c-bd2b-04cf7f92038c&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/5cdf095346e0fb036233d0f2/slots/5cdf095346e0fb036233d0f4 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Mon, 05 Jun 2017 04:03:02 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1652

{
  "id" : "5cdf095346e0fb036233d0f4",
  "eventId" : "5cdf095346e0fb036233d0f1",
  "editionId" : "5cdf095346e0fb036233d0f2",
  "createdBy" : "user",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2017-06-05T04:03:02.000Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5cdf095346e0fb036233d0f0",
  "slotId" : "5986d171-1d56-4e59-94bc-9c3ddf5580ff",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0f2/slots/5cdf095346e0fb036233d0f4"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0f2/slots/5cdf095346e0fb036233d0f4"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0f2"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5986d171-1d56-4e59-94bc-9c3ddf5580ff{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0f2/slots/5cdf095346e0fb036233d0f4/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf095346e0fb036233d0f2/slots/5cdf095346e0fb036233d0f4/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Removing the association between a Slot and an Edition

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request
DELETE /v2/content/editions/5cdf096446e0fb036233d2c3/slots/5cdf096446e0fb036233d2c5 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/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208/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" : "8ee70b8e-4f39-4a57-adba-c37b104d610a",
        "locked" : true
      },
      "id" : "5cdf096346e0fb036233d20e",
      "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
    }
  },
  "label" : "Simple Slot"
}

Example response

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

{
  "id" : "5cdf096346e0fb036233d208",
  "eventId" : "5cdf096346e0fb036233d202",
  "editionId" : "5cdf096346e0fb036233d203",
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:20:03.472Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:03.635Z",
  "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" : "8ee70b8e-4f39-4a57-adba-c37b104d610a",
          "locked" : true
        },
        "id" : "5cdf096346e0fb036233d20e",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5cdf096346e0fb036233d205",
  "slotId" : "7ee3c764-b4c2-44c1-a28e-0a974023b669",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

{
  "id" : "5cdf096346e0fb036233d208",
  "eventId" : "5cdf096346e0fb036233d202",
  "editionId" : "5cdf096346e0fb036233d203",
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:20:03.472Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:03.635Z",
  "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" : "8ee70b8e-4f39-4a57-adba-c37b104d610a",
          "locked" : true
        },
        "id" : "5cdf096346e0fb036233d20e",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5cdf096346e0fb036233d205",
  "slotId" : "7ee3c764-b4c2-44c1-a28e-0a974023b669",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7ee3c764-b4c2-44c1-a28e-0a974023b669{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d203/slots/5cdf096346e0fb036233d208/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

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

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - EDIT_EDITION

Example request

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

Example response

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

{
  "id" : "5cdf096346e0fb036233d200",
  "eventId" : "5cdf096346e0fb036233d1fa",
  "editionId" : "5cdf096346e0fb036233d1fb",
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:20:03.233Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:03.290Z",
  "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" : "5cdf096346e0fb036233d1fd",
  "slotId" : "7e343647-e882-463c-b16b-736677319688",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d1fb/slots/5cdf096346e0fb036233d200"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d1fb/slots/5cdf096346e0fb036233d200"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d1fb"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7e343647-e882-463c-b16b-736677319688{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d1fb/slots/5cdf096346e0fb036233d200/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf096346e0fb036233d1fb/slots/5cdf096346e0fb036233d200/content{?lastModifiedDate,page,size,sort}",
      "templated" : true
    }
  }
}

Snapshot

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

Creating a new Snapshot

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

POST /v2/content/hubs/5cdf097046e0fb036233df36/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" : "54dbb801-7ce9-4f95-bab1-466161e9b827",
  "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/5cdf097046e0fb036233df3d
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5cdf097046e0fb036233df3d",
  "comment" : "This is an example snapshot.",
  "createdDate" : "2017-06-05T04:03:02Z",
  "createdBy" : "thor",
  "createdFrom" : "content-item",
  "type" : "USER",
  "meta" : [ ],
  "taggedEditions" : [ ],
  "locale" : null,
  "rootContentItem" : {
    "label" : "Banner Ad Homepage",
    "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
    "id" : "54dbb801-7ce9-4f95-bab1-466161e9b827"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097046e0fb036233df36"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/54dbb801-7ce9-4f95-bab1-466161e9b827"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097046e0fb036233df3d/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5cdf097446e0fb036233e7ca/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: 4204

{
  "_embedded" : {
    "snapshots" : [ {
      "id" : "5cdf097446e0fb036233e7d1",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-05-17T19:20:20.98Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "locale" : null,
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "54286082-cda9-4162-ba24-7df9bdae5ab1"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/54286082-cda9-4162-ba24-7df9bdae5ab1"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d1/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5cdf097446e0fb036233e7d2",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-05-17T19:20:20.996Z",
      "createdBy" : "user",
      "createdFrom" : "content-item",
      "type" : "USER",
      "meta" : [ ],
      "taggedEditions" : [ ],
      "locale" : null,
      "rootContentItem" : {
        "label" : "Banner Ad Homepage",
        "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "id" : "12034c48-0db4-4bc4-964b-10f8a960f6f8"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/12034c48-0db4-4bc4-964b-10f8a960f6f8"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097446e0fb036233e7d2/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097446e0fb036233e7ca/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/5cdf097646e0fb036233e8a4 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

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

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

{
  "editionId" : "5cdf097646e0fb036233e853",
  "createdDate" : "2019-05-17T19:20:22Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5cdf097646e0fb036233e853"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097646e0fb036233e854/edition-links/5cdf097646e0fb036233e853"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5cdf097546e0fb036233e82f/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" : "5cdf097546e0fb036233e835",
      "createdDate" : "2019-05-17T19:20:22Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf097546e0fb036233e835"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links/5cdf097546e0fb036233e835"
        }
      }
    }, {
      "editionId" : "5cdf097546e0fb036233e836",
      "createdDate" : "2019-05-17T19:20:22Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf097546e0fb036233e836"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links/5cdf097546e0fb036233e836"
        }
      }
    }, {
      "editionId" : "5cdf097546e0fb036233e837",
      "createdDate" : "2019-05-17T19:20:22Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf097546e0fb036233e837"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links/5cdf097546e0fb036233e837"
        }
      }
    }, {
      "editionId" : "5cdf097546e0fb036233e838",
      "createdDate" : "2019-05-17T19:20:22Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf097546e0fb036233e838"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links/5cdf097546e0fb036233e838"
        }
      }
    }, {
      "editionId" : "5cdf097546e0fb036233e839",
      "createdDate" : "2019-05-17T19:20:22Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5cdf097546e0fb036233e839"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links/5cdf097546e0fb036233e839"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf097546e0fb036233e82f/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/5cdf096546e0fb036233d3b4/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-05-17T20:20:05.946Z"
}
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/5cdf096546e0fb036233d3b5
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5cdf096546e0fb036233d3b5",
  "scheduledDate" : "2019-05-17T20:20:05.946Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5cdf096546e0fb036233d3b5"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5cdf096546e0fb036233d3b5"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf096546e0fb036233d3b4"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5cdf096546e0fb036233d3b5"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5cdf096546e0fb036233d365 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" : "5cdf096546e0fb036233d365",
  "scheduledDate" : "2019-06-17T19:20:05.523Z",
  "createdDate" : "2019-05-17T19:20:05.533Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5cdf096546e0fb036233d365"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5cdf096546e0fb036233d365"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5cdf096546e0fb036233d364"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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

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

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

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

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

Item-level localization

Assigning a locale to a Content Item

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

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

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

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

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

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

{
  "id" : "c2b61480-b606-4b53-aea9-78abcdcb0c8a",
  "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-05-17T19:18:26.637Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:26.637Z",
  "deliveryId" : "c2b61480-b606-4b53-aea9-78abcdcb0c8a",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c2b61480-b606-4b53-aea9-78abcdcb0c8a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090246e0fb036233c523"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c2b61480-b606-4b53-aea9-78abcdcb0c8a",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c2b61480-b606-4b53-aea9-78abcdcb0c8a{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c2b61480-b606-4b53-aea9-78abcdcb0c8a/workflow"
    }
  }
}
Auth rules
Required Functional Permissions:
  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request
POST /v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/locale HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 41

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

{
  "id" : "74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2",
  "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-05-17T19:18:26.376Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:18:26.411Z",
  "deliveryId" : "74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2{?projection}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/publish"
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/planned{?epoch,time}",
      "templated" : true
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf090246e0fb036233c51c"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/74d5ade0-1fa9-4c9c-8009-e8eeb3bb75c2/workflow"
    }
  }
}

Localizing a content graph

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

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

Required ACLs:
  • Hub - READ

  • ContentRepository - CREATE_CONTENT

Example request
POST /v2/content/content-items/adcf7c2e-110e-4d32-9245-62a88d75253e/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" : "adcf7c2e-110e-4d32-9245-62a88d75253e"
  },
  "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/adcf7c2e-110e-4d32-9245-62a88d75253e"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=adcf7c2e-110e-4d32-9245-62a88d75253e{&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/6ff4608a-3fd6-4168-9bb9-c2e3a685c239/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" : "6ff4608a-3fd6-4168-9bb9-c2e3a685c239",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ff4608a-3fd6-4168-9bb9-c2e3a685c239"
        }
      }
    }, {
      "id" : "6280ba96-b974-4e0e-931d-5b6b56ac82fa",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6280ba96-b974-4e0e-931d-5b6b56ac82fa"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6ff4608a-3fd6-4168-9bb9-c2e3a685c239/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6ff4608a-3fd6-4168-9bb9-c2e3a685c239/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6ff4608a-3fd6-4168-9bb9-c2e3a685c239/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=e31e8740-a4c7-40fc-b11b-e3d9c350e469 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" : "e31e8740-a4c7-40fc-b11b-e3d9c350e469"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-05-17T19:20:23.440Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e31e8740-a4c7-40fc-b11b-e3d9c350e469"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e31e8740-a4c7-40fc-b11b-e3d9c350e469{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e31e8740-a4c7-40fc-b11b-e3d9c350e469&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e31e8740-a4c7-40fc-b11b-e3d9c350e469&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e31e8740-a4c7-40fc-b11b-e3d9c350e469&page=0&size=20"
    },
    "search-localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Localization jobs can have the following status codes:

Table 4. Localization Job Status
Status Description

IN_PROGRESS

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

SUCCEEDED

The localization job has been completed successfully.

PARTIALLY_SUCCEEDED

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

FAILURE

The localization job was unsuccessful

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

Assigning a set of locales to a Content Repository

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

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

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

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT

Example request
PATCH /v2/content/content-repositories/5cdf092146e0fb036233c92e/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" : "5cdf092146e0fb036233c92e",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf092146e0fb036233c92d"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf092146e0fb036233c92d/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf092146e0fb036233c92d/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/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/5cdf092146e0fb036233c92e/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5cdf092146e0fb036233c92e/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/5cdf092046e0fb036233c845/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

{
  "newRepositoryId" : "5cdf092046e0fb036233c843"
}
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/5cdf092246e0fb036233c9c7/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/5cdf092246e0fb036233c9c7/localization-group/locales"
    }
  }
}

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

Administration

Listing Administrative Operations

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

The following operations are available based on your permissions

Table 5. Operations
Operation rel

Manage Access

"access"

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Managing Access

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

Auth rules

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

Example request

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

Example response

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

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

Listing operations for a resource

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

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

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

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/hubs/5cdf08fd46e0fb036233c22b 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/5cdf08fd46e0fb036233c22b"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c22b/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c22b/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/5cdf08fd46e0fb036233c22a 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/5cdf08fd46e0fb036233c22a"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c22a/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c22a/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/5cdf08fd46e0fb036233c274/members HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "members" : [ {
      "sid" : "alice",
      "permissions" : [ "READ", "EDIT", "DELETE", "SHARE", "CREATE_REPOSITORY", "CREATE_EVENT", "EDIT_EVENT", "DELETE_EVENT", "CREATE_EDITION", "EDIT_EDITION", "DELETE_EDITION", "MANAGE_ACCESS", "EDIT_WORKFLOW_STATES" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fd46e0fb036233c274/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/5cdf08fd46e0fb036233c276/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/5cdf08fd46e0fb036233c276/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/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/5cdf08fd46e0fb036233c276/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5cdf08fd46e0fb036233c276/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/5cdf08fb46e0fb036233c14e/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/5cdf08fb46e0fb036233c14e/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5cdf08fb46e0fb036233c14e/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/5cdf08fc46e0fb036233c197/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/5cdf08fc46e0fb036233c198/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/5cdf096646e0fb036233d402/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/5cdf096646e0fb036233d402/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/5cdf096646e0fb036233d402/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d402"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d402/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d402/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d402/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d402/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/5cdf096646e0fb036233d3ff/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/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/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/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/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/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d3ff/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/5cdf096646e0fb036233d451/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/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/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/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/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/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d451/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/5cdf096646e0fb036233d407/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/5cdf096646e0fb036233d407/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d407"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d407/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d407/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d407/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf096646e0fb036233d407/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

Workflows

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

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

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

Creating a Workflow State

You may create up to 100 workflow states per hub.

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - EDIT_WORKFLOW_STATES

Example request

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

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

Example response

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

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

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Get a Workflow State

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

{
  "id" : "5cdf097046e0fb036233dea3",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2019-05-17T19:20:16.260Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-05-17T19:20:16.260Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5cdf097046e0fb036233dea3"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5cdf097046e0fb036233dea3"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5cdf097046e0fb036233dea2"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5cdf097046e0fb036233dea3"
    }
  }
}

Update a Workflow State

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - EDIT_WORKFLOW_STATES

Example request

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

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

Example response

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

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

Integrations

Salesforce Commerce Cloud (SFCC) Integration

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

Listing the Salesforce Commerce Cloud (SFCC) Integrations

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

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

  • PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:READ

Required ACLs:
  • Hub - READ

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

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

Creating a new Salesforce Commerce Cloud (SFCC) Integration

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

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

  • PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:CREATE

  • CONTENT:FUNCTIONAL:WEBHOOK:CREATE

Required ACLs:
  • Hub - READ

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

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