Expand all

Integrating with the API

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

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

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

Example request

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

Example response

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

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

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

Information

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

Supported Localization Settings

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

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Hubs

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

Creating a new Hub

Auth rules

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

Example request

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

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

Example response

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

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

{
  "_embedded" : {
    "hubs" : [ {
      "id" : "5c881fc6c9e77c03383e37a5",
      "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-03-12T21:08:22.524Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:22.524Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/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/5c881fc6c9e77c03383e37a5/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a5/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fc6c9e77c03383e37a6",
      "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-03-12T21:08:22.559Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:22.559Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/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/5c881fc6c9e77c03383e37a6/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a6/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fc6c9e77c03383e37a7",
      "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-03-12T21:08:22.587Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:22.587Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/events"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-types{?page,size,sort}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-type-schemas{?page,size,sort}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/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/5c881fc6c9e77c03383e37a7/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e37a7/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/5c88206fc9e77c03383e5f3c HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:11:11 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4724

{
  "id" : "5c88206fc9e77c03383e5f3c",
  "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-03-12T21:11:11.972Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:11:11.972Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/events"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/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/5c88206fc9e77c03383e5f3c/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/webhooks"
    },
    "integrations" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/integrations{?page,size,sort}",
      "templated" : true
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88206fc9e77c03383e5f3c/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/5c881fc6c9e77c03383e375c 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: Tue, 12 Mar 2019 21:08:22 GMT
Location: https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4277

{
  "id" : "5c881fc6c9e77c03383e375c",
  "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-03-12T21:08:22.363Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:22.406Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/events"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-types{?page,size,sort}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-type-schemas{?page,size,sort}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/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/5c881fc6c9e77c03383e375c/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc6c9e77c03383e375c/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/5c882070c9e77c03383e5f85/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/5c882070c9e77c03383e5f85

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

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

POST /v2/content/hubs/5c881fc6c9e77c03383e36ca/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:READ

  • CONTENT:FUNCTIONAL:CONTENT_TYPE:CREATE

Required ACLs:
  • Hub - READ

Example request

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

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

{
  "contentTypeId" : "5c881ff5c9e77c03383e4023"
}

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5c881ff6c9e77c03383e40c2",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff6c9e77c03383e40be"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff6c9e77c03383e40be/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff6c9e77c03383e40be/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/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/5c881ff6c9e77c03383e40c2/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff6c9e77c03383e40c2/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/5c881fc0c9e77c03383e3054/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" : "5c881fc1c9e77c03383e3057",
      "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/5c881fc1c9e77c03383e3057"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3057"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3057/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3057/schema"
        }
      }
    }, {
      "id" : "5c881fc1c9e77c03383e3059",
      "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/5c881fc1c9e77c03383e3059"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3059"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3059/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e3059/schema"
        }
      }
    }, {
      "id" : "5c881fc1c9e77c03383e305b",
      "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/5c881fc1c9e77c03383e305b"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e305b"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e305b/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5c881fc1c9e77c03383e305b/schema"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc0c9e77c03383e3054/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc0c9e77c03383e3054/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc0c9e77c03383e3054/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc0c9e77c03383e3054/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/5c881fc0c9e77c03383e300b 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" : "5c881fc0c9e77c03383e300b",
  "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/5c881fc0c9e77c03383e300b"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c881fc0c9e77c03383e300b"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c881fc0c9e77c03383e300b/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5c881fc0c9e77c03383e300b/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/5c881fc0c9e77c03383e2fbf 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/5c881fc0c9e77c03383e2fbf
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1016

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

Update a Content Type Schema

Auth rules

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

  • CONTENT:FUNCTIONAL:CONTENT_TYPE:EDIT

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/content-types/5c881fc1c9e77c03383e30f3/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" : "5c881fc1c9e77c03383e30f0",
  "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/5c881fc1c9e77c03383e30f3/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/5c881fc3c9e77c03383e326a/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/5c881fc3c9e77c03383e326b
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

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

{
  "id" : "5c881fc4c9e77c03383e3395",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc4c9e77c03383e3394"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc4c9e77c03383e3394/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fc4c9e77c03383e3394/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/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/5c881fc4c9e77c03383e3395/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fc4c9e77c03383e3395/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/5c881ff6c9e77c03383e4071/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/5c881ff6c9e77c03383e4075/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/5c881ff5c9e77c03383e406d/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" : "5c881ff5c9e77c03383e406f",
      "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/5c881ff5c9e77c03383e406f"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/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/5c881ff5c9e77c03383e406f/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff5c9e77c03383e406f/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff5c9e77c03383e406d/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/5c881fc2c9e77c03383e3221/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/5c881fbdc9e77c03383e2e2b/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" : "5c881fbdc9e77c03383e2e2f",
  "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: Tue, 12 Mar 2019 21:08:13 GMT
Location: https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "aef15ea0-47e6-42b5-ad30-8d74b116651a",
  "folderId" : "5c881fbdc9e77c03383e2e2f",
  "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-03-12T21:08:13.733Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:13.733Z",
  "deliveryId" : "aef15ea0-47e6-42b5-ad30-8d74b116651a",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=aef15ea0-47e6-42b5-ad30-8d74b116651a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbdc9e77c03383e2e2b"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=aef15ea0-47e6-42b5-ad30-8d74b116651a",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c881fbdc9e77c03383e2e2f"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=aef15ea0-47e6-42b5-ad30-8d74b116651a{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aef15ea0-47e6-42b5-ad30-8d74b116651a/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/c76f4137-7016-4980-ab51-36dae1e0ec9c 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: Tue, 12 Mar 2019 21:08:13 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "c76f4137-7016-4980-ab51-36dae1e0ec9c",
  "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-03-12T21:08:13.144Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:13.144Z",
  "deliveryId" : "c76f4137-7016-4980-ab51-36dae1e0ec9c",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c76f4137-7016-4980-ab51-36dae1e0ec9c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbcc9e77c03383e2ddd"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c76f4137-7016-4980-ab51-36dae1e0ec9c",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c76f4137-7016-4980-ab51-36dae1e0ec9c{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c76f4137-7016-4980-ab51-36dae1e0ec9c/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/aabcfa0f-478e-4b6f-8b64-ea418558422e 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" : "5c881fbec9e77c03383e2e7f"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:08:14 GMT
Location: https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "aabcfa0f-478e-4b6f-8b64-ea418558422e",
  "folderId" : "5c881fbec9e77c03383e2e7f",
  "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-03-12T21:08:14.259Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:14.330Z",
  "deliveryId" : "aabcfa0f-478e-4b6f-8b64-ea418558422e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=aabcfa0f-478e-4b6f-8b64-ea418558422e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbdc9e77c03383e2e7b"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=aabcfa0f-478e-4b6f-8b64-ea418558422e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c881fbec9e77c03383e2e7f"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=aabcfa0f-478e-4b6f-8b64-ea418558422e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/aabcfa0f-478e-4b6f-8b64-ea418558422e/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/5c881fe4c9e77c03383e3eef/content-items?sourceContentItemId=6cbeba9f-0e56-4fbd-9d3a-f292765549b9 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: Tue, 12 Mar 2019 21:08:52 GMT
Location: https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "458ba689-2473-413d-9d1f-5e1b9ed11010",
  "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-03-12T21:08:52.613Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:52.613Z",
  "deliveryId" : "458ba689-2473-413d-9d1f-5e1b9ed11010",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=458ba689-2473-413d-9d1f-5e1b9ed11010"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe4c9e77c03383e3eef"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=458ba689-2473-413d-9d1f-5e1b9ed11010",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=458ba689-2473-413d-9d1f-5e1b9ed11010{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/458ba689-2473-413d-9d1f-5e1b9ed11010/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/5c881fe4c9e77c03383e3ef6/content-items?sourceContentItemId=bee4616c-10e7-4879-bcd5-be8022abef34 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" : "5c881fe4c9e77c03383e3efc"
}

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, 12 Mar 2019 21:08:52 GMT
Location: https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "6f04586b-a584-41e0-99a8-ca97392aeeb1",
  "folderId" : "5c881fe4c9e77c03383e3efc",
  "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-03-12T21:08:52.899Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:52.899Z",
  "deliveryId" : "6f04586b-a584-41e0-99a8-ca97392aeeb1",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6f04586b-a584-41e0-99a8-ca97392aeeb1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe4c9e77c03383e3ef6"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6f04586b-a584-41e0-99a8-ca97392aeeb1",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5c881fe4c9e77c03383e3efc"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6f04586b-a584-41e0-99a8-ca97392aeeb1{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6f04586b-a584-41e0-99a8-ca97392aeeb1/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/59482bde-be51-4fc8-a343-544216fa6f2a/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" : "59482bde-be51-4fc8-a343-544216fa6f2a",
  "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-03-12T21:08:46.566Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:46.595Z",
  "deliveryId" : "59482bde-be51-4fc8-a343-544216fa6f2a",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=59482bde-be51-4fc8-a343-544216fa6f2a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdec9e77c03383e3bdb"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=59482bde-be51-4fc8-a343-544216fa6f2a",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=59482bde-be51-4fc8-a343-544216fa6f2a{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/59482bde-be51-4fc8-a343-544216fa6f2a/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/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/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" : "1d1059ab-e931-416b-aa8c-3d355bd0e1ba",
  "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" : "1d1059ab-e931-416b-aa8c-3d355bd0e1ba",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1d1059ab-e931-416b-aa8c-3d355bd0e1ba"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe1c9e77c03383e3d4a"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1d1059ab-e931-416b-aa8c-3d355bd0e1ba",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1d1059ab-e931-416b-aa8c-3d355bd0e1ba{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/1d1059ab-e931-416b-aa8c-3d355bd0e1ba/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" : "5c881fbfc9e77c03383e2f6f",
  "id" : "c33233fc-a11e-4cd7-a6b4-01a6ac3e390b"
}, {
  "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" : "5c881fbfc9e77c03383e2f6f",
  "id" : "f04f759e-1e1f-46cf-84ef-fb975008a181"
} ]

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" : "c33233fc-a11e-4cd7-a6b4-01a6ac3e390b",
    "status" : 200,
    "description" : null
  }, {
    "id" : "f04f759e-1e1f-46cf-84ef-fb975008a181",
    "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/5c881fbec9e77c03383e2ecb/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" : "fc9d2fda-8e83-4275-8f7d-d4525e5bc70c",
      "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-03-12T21:08:14.897Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:14.897Z",
      "deliveryId" : "fc9d2fda-8e83-4275-8f7d-d4525e5bc70c",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fc9d2fda-8e83-4275-8f7d-d4525e5bc70c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fc9d2fda-8e83-4275-8f7d-d4525e5bc70c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fc9d2fda-8e83-4275-8f7d-d4525e5bc70c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc9d2fda-8e83-4275-8f7d-d4525e5bc70c/workflow"
        }
      }
    }, {
      "id" : "6c6b2090-957a-4582-9b02-adf435dffe66",
      "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-03-12T21:08:14.848Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:14.848Z",
      "deliveryId" : "6c6b2090-957a-4582-9b02-adf435dffe66",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6c6b2090-957a-4582-9b02-adf435dffe66"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6c6b2090-957a-4582-9b02-adf435dffe66",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6c6b2090-957a-4582-9b02-adf435dffe66{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6c6b2090-957a-4582-9b02-adf435dffe66/workflow"
        }
      }
    }, {
      "id" : "e544de96-0884-41ae-8532-cbf688c36839",
      "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-03-12T21:08:14.798Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:14.798Z",
      "deliveryId" : "e544de96-0884-41ae-8532-cbf688c36839",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=e544de96-0884-41ae-8532-cbf688c36839"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e544de96-0884-41ae-8532-cbf688c36839",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e544de96-0884-41ae-8532-cbf688c36839{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e544de96-0884-41ae-8532-cbf688c36839/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbec9e77c03383e2ecb/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/5c881fddc9e77c03383e3b8c/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" : "952391d9-2300-4abc-8e1c-f40086935888",
      "folderId" : null,
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "locale" : "en",
      "status" : "ACTIVE",
      "id" : "952391d9-2300-4abc-8e1c-f40086935888",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=952391d9-2300-4abc-8e1c-f40086935888"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fddc9e77c03383e3b8c"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=952391d9-2300-4abc-8e1c-f40086935888",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=952391d9-2300-4abc-8e1c-f40086935888{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/952391d9-2300-4abc-8e1c-f40086935888/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fddc9e77c03383e3b8c/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fddc9e77c03383e3b8c/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fddc9e77c03383e3b8c/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fddc9e77c03383e3b8c/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/5c881fbfc9e77c03383e2f1b/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" : "2ac05eab-da66-4b75-939c-d31b4d8ece24",
      "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-03-12T21:08:15.402Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:15.402Z",
      "deliveryId" : "2ac05eab-da66-4b75-939c-d31b4d8ece24",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2ac05eab-da66-4b75-939c-d31b4d8ece24"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2ac05eab-da66-4b75-939c-d31b4d8ece24",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2ac05eab-da66-4b75-939c-d31b4d8ece24{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2ac05eab-da66-4b75-939c-d31b4d8ece24/workflow"
        }
      }
    }, {
      "id" : "4ca2315d-cd21-408b-87d1-a17e6caec41b",
      "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-03-12T21:08:15.443Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:15.443Z",
      "deliveryId" : "4ca2315d-cd21-408b-87d1-a17e6caec41b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4ca2315d-cd21-408b-87d1-a17e6caec41b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4ca2315d-cd21-408b-87d1-a17e6caec41b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4ca2315d-cd21-408b-87d1-a17e6caec41b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4ca2315d-cd21-408b-87d1-a17e6caec41b/workflow"
        }
      }
    }, {
      "id" : "8e594572-7d7b-491f-bad6-58136d981285",
      "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-03-12T21:08:15.482Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:15.482Z",
      "deliveryId" : "8e594572-7d7b-491f-bad6-58136d981285",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8e594572-7d7b-491f-bad6-58136d981285"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8e594572-7d7b-491f-bad6-58136d981285",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8e594572-7d7b-491f-bad6-58136d981285{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8e594572-7d7b-491f-bad6-58136d981285/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbfc9e77c03383e2f1b/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/5c881fdfc9e77c03383e3c8e/content-items?folderId=5c881fe0c9e77c03383e3c92 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "b2902aa8-a9cf-4398-95e3-f75ed23b3f88",
      "folderId" : "5c881fe0c9e77c03383e3c92",
      "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-03-12T21:08:48.110Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.110Z",
      "deliveryId" : "b2902aa8-a9cf-4398-95e3-f75ed23b3f88",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b2902aa8-a9cf-4398-95e3-f75ed23b3f88"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c8e"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b2902aa8-a9cf-4398-95e3-f75ed23b3f88",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3c92"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b2902aa8-a9cf-4398-95e3-f75ed23b3f88{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b2902aa8-a9cf-4398-95e3-f75ed23b3f88/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c8e/content-items?folderId=5c881fe0c9e77c03383e3c92&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c8e/content-items?folderId=5c881fe0c9e77c03383e3c92&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c8e/content-items?folderId=5c881fe0c9e77c03383e3c92&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c8e/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/5c881fdfc9e77c03383e3c82/content-items?folderId=5c881fdfc9e77c03383e3c86,5c881fdfc9e77c03383e3c87 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "49947851-c6c1-427d-9e1a-120e3901f7bd",
      "folderId" : "5c881fdfc9e77c03383e3c87",
      "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-03-12T21:08:47.770Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:47.770Z",
      "deliveryId" : "49947851-c6c1-427d-9e1a-120e3901f7bd",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=49947851-c6c1-427d-9e1a-120e3901f7bd"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=49947851-c6c1-427d-9e1a-120e3901f7bd",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fdfc9e77c03383e3c87"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=49947851-c6c1-427d-9e1a-120e3901f7bd{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49947851-c6c1-427d-9e1a-120e3901f7bd/workflow"
        }
      }
    }, {
      "id" : "172dd35f-c0d4-4e54-9899-c5f8ac73793a",
      "folderId" : "5c881fdfc9e77c03383e3c87",
      "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-03-12T21:08:47.731Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:47.731Z",
      "deliveryId" : "172dd35f-c0d4-4e54-9899-c5f8ac73793a",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=172dd35f-c0d4-4e54-9899-c5f8ac73793a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=172dd35f-c0d4-4e54-9899-c5f8ac73793a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fdfc9e77c03383e3c87"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=172dd35f-c0d4-4e54-9899-c5f8ac73793a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/172dd35f-c0d4-4e54-9899-c5f8ac73793a/workflow"
        }
      }
    }, {
      "id" : "4878fd89-b333-4d54-b10a-f70d88f5b019",
      "folderId" : "5c881fdfc9e77c03383e3c87",
      "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-03-12T21:08:47.690Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:47.690Z",
      "deliveryId" : "4878fd89-b333-4d54-b10a-f70d88f5b019",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=4878fd89-b333-4d54-b10a-f70d88f5b019"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4878fd89-b333-4d54-b10a-f70d88f5b019",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fdfc9e77c03383e3c87"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4878fd89-b333-4d54-b10a-f70d88f5b019{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4878fd89-b333-4d54-b10a-f70d88f5b019/workflow"
        }
      }
    }, {
      "id" : "cd47a1a5-278b-4f3f-8821-0338aba55188",
      "folderId" : "5c881fdfc9e77c03383e3c86",
      "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-03-12T21:08:47.645Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:47.645Z",
      "deliveryId" : "cd47a1a5-278b-4f3f-8821-0338aba55188",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=cd47a1a5-278b-4f3f-8821-0338aba55188"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cd47a1a5-278b-4f3f-8821-0338aba55188",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fdfc9e77c03383e3c86"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cd47a1a5-278b-4f3f-8821-0338aba55188{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cd47a1a5-278b-4f3f-8821-0338aba55188/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82/content-items?folderId=5c881fdfc9e77c03383e3c86,5c881fdfc9e77c03383e3c87&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82/content-items?folderId=5c881fdfc9e77c03383e3c86,5c881fdfc9e77c03383e3c87&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82/content-items?folderId=5c881fdfc9e77c03383e3c86,5c881fdfc9e77c03383e3c87&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdfc9e77c03383e3c82/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/5c881fe0c9e77c03383e3c9a/content-items?folderId=5c881fe0c9e77c03383e3c9e&folderId=5c881fe0c9e77c03383e3c9f HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac",
      "folderId" : "5c881fe0c9e77c03383e3c9f",
      "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-03-12T21:08:48.531Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.531Z",
      "deliveryId" : "8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3c9f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8b690e1c-ca94-4a3d-a1ee-6ed1b172f7ac/workflow"
        }
      }
    }, {
      "id" : "5fde722b-ccda-4748-b09f-3fb5c516235b",
      "folderId" : "5c881fe0c9e77c03383e3c9f",
      "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-03-12T21:08:48.501Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.501Z",
      "deliveryId" : "5fde722b-ccda-4748-b09f-3fb5c516235b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5fde722b-ccda-4748-b09f-3fb5c516235b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5fde722b-ccda-4748-b09f-3fb5c516235b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3c9f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5fde722b-ccda-4748-b09f-3fb5c516235b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5fde722b-ccda-4748-b09f-3fb5c516235b/workflow"
        }
      }
    }, {
      "id" : "2733cc14-c2e0-47d2-a41b-44c275d9cd92",
      "folderId" : "5c881fe0c9e77c03383e3c9f",
      "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-03-12T21:08:48.473Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.473Z",
      "deliveryId" : "2733cc14-c2e0-47d2-a41b-44c275d9cd92",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2733cc14-c2e0-47d2-a41b-44c275d9cd92"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2733cc14-c2e0-47d2-a41b-44c275d9cd92",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3c9f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2733cc14-c2e0-47d2-a41b-44c275d9cd92{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2733cc14-c2e0-47d2-a41b-44c275d9cd92/workflow"
        }
      }
    }, {
      "id" : "2f8db65e-4724-4023-b456-8188cc2a3694",
      "folderId" : "5c881fe0c9e77c03383e3c9e",
      "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-03-12T21:08:48.443Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.443Z",
      "deliveryId" : "2f8db65e-4724-4023-b456-8188cc2a3694",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2f8db65e-4724-4023-b456-8188cc2a3694"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2f8db65e-4724-4023-b456-8188cc2a3694",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3c9e"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2f8db65e-4724-4023-b456-8188cc2a3694{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2f8db65e-4724-4023-b456-8188cc2a3694/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a/content-items?folderId=5c881fe0c9e77c03383e3c9e&folderId=5c881fe0c9e77c03383e3c9f&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a/content-items?folderId=5c881fe0c9e77c03383e3c9e&folderId=5c881fe0c9e77c03383e3c9f&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a/content-items?folderId=5c881fe0c9e77c03383e3c9e&folderId=5c881fe0c9e77c03383e3c9f&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3c9a/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/5c881fe0c9e77c03383e3ca6/content-items?folderId=!5c881fe0c9e77c03383e3caa HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "96c68298-4ec8-4d68-9787-da5f891c2e17",
      "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-03-12T21:08:48.946Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.946Z",
      "deliveryId" : "96c68298-4ec8-4d68-9787-da5f891c2e17",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=96c68298-4ec8-4d68-9787-da5f891c2e17"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=96c68298-4ec8-4d68-9787-da5f891c2e17",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=96c68298-4ec8-4d68-9787-da5f891c2e17{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/96c68298-4ec8-4d68-9787-da5f891c2e17/workflow"
        }
      }
    }, {
      "id" : "be5a0db5-9154-48fc-b730-d1d9f9930caf",
      "folderId" : "5c881fe0c9e77c03383e3cab",
      "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-03-12T21:08:48.908Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.908Z",
      "deliveryId" : "be5a0db5-9154-48fc-b730-d1d9f9930caf",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=be5a0db5-9154-48fc-b730-d1d9f9930caf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=be5a0db5-9154-48fc-b730-d1d9f9930caf",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3cab"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=be5a0db5-9154-48fc-b730-d1d9f9930caf{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/be5a0db5-9154-48fc-b730-d1d9f9930caf/workflow"
        }
      }
    }, {
      "id" : "6928576a-9a16-4130-8f69-186692e2c78d",
      "folderId" : "5c881fe0c9e77c03383e3cab",
      "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-03-12T21:08:48.870Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.870Z",
      "deliveryId" : "6928576a-9a16-4130-8f69-186692e2c78d",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=6928576a-9a16-4130-8f69-186692e2c78d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6928576a-9a16-4130-8f69-186692e2c78d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3cab"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6928576a-9a16-4130-8f69-186692e2c78d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6928576a-9a16-4130-8f69-186692e2c78d/workflow"
        }
      }
    }, {
      "id" : "7da93667-7f73-4fa0-af6a-b94963623eb1",
      "folderId" : "5c881fe0c9e77c03383e3cab",
      "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-03-12T21:08:48.829Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:48.829Z",
      "deliveryId" : "7da93667-7f73-4fa0-af6a-b94963623eb1",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7da93667-7f73-4fa0-af6a-b94963623eb1"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7da93667-7f73-4fa0-af6a-b94963623eb1",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5c881fe0c9e77c03383e3cab"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7da93667-7f73-4fa0-af6a-b94963623eb1{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7da93667-7f73-4fa0-af6a-b94963623eb1/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6/content-items?folderId=!5c881fe0c9e77c03383e3caa&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6/content-items?folderId=!5c881fe0c9e77c03383e3caa&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6/content-items?folderId=!5c881fe0c9e77c03383e3caa&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe0c9e77c03383e3ca6/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/cedc4e36-53ab-4816-bee3-dc60a0dac25d/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-03-12T21:09:12.246Z",
        "historyEventId" : "20c86ede-4166-4e45-801d-b5c7aa2e0c0c"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "605b49b0-e9db-4099-a053-12e7c5d09eef",
        "createdDate" : "2019-03-02T21:09:12.260Z",
        "historyEventId" : "4e6796df-fea3-4edd-b3b4-8ffe6c7bf5a7"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d7faccbe-66b5-4a71-9455-5fab2b12c355",
        "createdDate" : "2019-03-01T21:09:12.260Z",
        "historyEventId" : "1e3d6760-274a-477f-9e2c-977cb1d12be7"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b0c366ce-a6aa-486b-bf3f-101b66a98556",
        "createdDate" : "2019-02-28T21:09:12.260Z",
        "historyEventId" : "d8315ada-2cbf-46b4-a8e0-99bc688659f0"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "f9a71203-925c-4916-b1b9-45f0ecab748c",
        "createdDate" : "2019-02-27T21:09:12.260Z",
        "historyEventId" : "6ae98a81-e3bd-4feb-b4f6-5bed500158b6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c63513f4-6f39-4b35-b965-fb32fd4de1e3",
        "createdDate" : "2019-02-26T21:09:12.260Z",
        "historyEventId" : "903d2046-fd66-4643-ae88-9c10b333c1cf"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:12.244Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:12.186Z",
        "historyEventId" : "2fde3285-2e0a-4619-9916-47718d1528a4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "fa8a702e-9a0b-43ff-8ad8-2168165e86c4",
        "createdDate" : "2019-03-01T21:09:12.260Z",
        "historyEventId" : "97d212de-8ba9-483f-b79c-97076a1dcf1d"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "92c98814-9ea4-4bf0-9956-07e725fef536",
        "createdDate" : "2019-02-28T21:09:12.260Z",
        "historyEventId" : "8c102e1a-7dbb-459a-8d3b-e572bb3e1213"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5de5990d-3a37-472d-8ee1-4f570df31e18",
        "createdDate" : "2019-02-27T21:09:12.260Z",
        "historyEventId" : "7b656065-5c20-4759-8380-e55b487e6891"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "e31ad7d8-51a1-4ce6-80d3-5c5b43d8a36d",
        "createdDate" : "2019-02-26T21:09:12.260Z",
        "historyEventId" : "490a9109-5c6b-4d80-8eb8-c7592f9812e9"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4072bd78-ea62-4a20-8935-755413b05a8c",
        "createdDate" : "2019-02-25T21:09:12.260Z",
        "historyEventId" : "ae5962b4-1340-497f-9a2b-a9e55ae7440a"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:12.184Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:12.128Z",
        "historyEventId" : "da72973a-12d4-4784-8e8e-34a8d509601b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "8225614b-763c-41e6-a1cc-e8c5937afa84",
        "createdDate" : "2019-02-28T21:09:12.260Z",
        "historyEventId" : "271c0ea3-191e-480e-b283-778e17e89458"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "bb1031cf-6f80-4c79-b207-14cc1c10046a",
        "createdDate" : "2019-02-27T21:09:12.260Z",
        "historyEventId" : "7e70f205-de83-4b9e-bf49-947c96fa7bc4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "8b725942-aafb-4b0e-b00d-74d414a2e93c",
        "createdDate" : "2019-02-26T21:09:12.260Z",
        "historyEventId" : "13d79ea9-b3c2-4abe-a391-86962a880599"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "0ae732d4-ce50-4893-9e3b-b6d773604a29",
        "createdDate" : "2019-02-25T21:09:12.260Z",
        "historyEventId" : "f6c42120-24a1-4854-a5f0-a25974d6f0d7"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "24088b56-9c09-4db3-97e9-e88664e8847d",
        "createdDate" : "2019-02-24T21:09:12.260Z",
        "historyEventId" : "3c76b08d-58a0-459c-a8a3-fb924a79deec"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:12.126Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:12.070Z",
        "historyEventId" : "d21c7a20-a6f6-4793-a04a-88a43e745a1e"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "bb7e720d-5855-4444-ab3e-1ca107a06b70",
        "createdDate" : "2019-02-27T21:09:12.260Z",
        "historyEventId" : "40ccdb20-4d0f-4d80-9171-dc865d87bf14"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "47833c34-7365-4e7f-a52d-83d75f10ae2f",
        "createdDate" : "2019-02-26T21:09:12.260Z",
        "historyEventId" : "d54faf5e-8ff1-4074-b627-e8d65e4fe87c"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "25a52169-556f-468f-b6ea-a2ccd0709ae7",
        "createdDate" : "2019-02-25T21:09:12.260Z",
        "historyEventId" : "d7a0d648-b069-421a-8f1d-8bb8dee44505"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "143b5a2b-ecf4-44d7-9759-4ba485bd7c58",
        "createdDate" : "2019-02-24T21:09:12.260Z",
        "historyEventId" : "0b9c2d33-f093-4f98-bfa9-10bebc8a3851"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "c3de094b-9530-4854-a210-4091dfe5f7a1",
        "createdDate" : "2019-02-23T21:09:12.260Z",
        "historyEventId" : "6089745e-d652-4489-b577-bb51ec99d882"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:12.068Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:12.012Z",
        "historyEventId" : "69654054-55af-4759-bc91-f9f045610136"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "63362d61-41d3-4258-b3ef-58abb362de1d",
        "createdDate" : "2019-02-26T21:09:12.260Z",
        "historyEventId" : "2a2a2843-2455-4c6a-8e1a-f37d528a92d8"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "88d829a5-5334-4cee-b82a-21decc1d5d5f",
        "createdDate" : "2019-02-25T21:09:12.260Z",
        "historyEventId" : "773b5648-0b4d-4bc6-9660-729a0f4d1317"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "1f9a8ba2-dacc-4563-9509-13061c04109c",
        "createdDate" : "2019-02-24T21:09:12.260Z",
        "historyEventId" : "a787c9b6-ab9f-4e5a-911e-97e7539146b1"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "4d468ae9-c201-43f3-b52e-e5744b4b900e",
        "createdDate" : "2019-02-23T21:09:12.260Z",
        "historyEventId" : "5f626ebf-bc94-44b3-a60e-3bf1a9855824"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "e10dbd02-13d8-4913-bab4-896c423e1492",
        "createdDate" : "2019-02-22T21:09:12.260Z",
        "historyEventId" : "806f9b47-8a33-4b43-8776-78cc8bcb8418"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:12.010Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:11.952Z",
        "historyEventId" : "9128af36-102c-4895-b954-5e93987767bb"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a73c3bc8-c91f-42a4-8d9f-5c124b7a5522",
        "createdDate" : "2019-02-25T21:09:12.260Z",
        "historyEventId" : "d091fd25-b1ae-4002-9e50-7f50586f3059"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "f0c04d64-6b43-4f73-b0c6-d5a720de0a58",
        "createdDate" : "2019-02-24T21:09:12.260Z",
        "historyEventId" : "5b70fefd-3ec9-4b19-bcf3-88e8f5646a86"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "fc82c43d-7eef-4591-b8cb-cd900d9b1448",
        "createdDate" : "2019-02-23T21:09:12.260Z",
        "historyEventId" : "9ef069a9-e2c0-4a0e-b4e1-224a724a3782"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "3d0ba7df-6cad-46de-ac89-873d8d148e43",
        "createdDate" : "2019-02-22T21:09:12.260Z",
        "historyEventId" : "2a4160bf-798f-4b3b-a167-9c597f3538d4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2ba2e15b-7ed4-4a30-bbff-9fe39d904152",
        "createdDate" : "2019-02-21T21:09:12.260Z",
        "historyEventId" : "8ac91b54-c709-4373-b212-81e37020d5c6"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:11.950Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:11.891Z",
        "historyEventId" : "73dd115f-06a7-4557-9dd0-87d039bbccf2"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "3c9cf515-3aee-4b5d-8de7-a4bc24e9c57e",
        "createdDate" : "2019-02-24T21:09:12.260Z",
        "historyEventId" : "16555812-848b-43fc-a386-66bf80eda0d6"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "64c3f6f4-8c97-4f6b-bada-53be56ef0371",
        "createdDate" : "2019-02-23T21:09:12.260Z",
        "historyEventId" : "94cdf023-e871-4c83-9d70-06afbec09d2d"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "8c0106bd-db5a-46dd-b0ff-11568b8c03fd",
        "createdDate" : "2019-02-22T21:09:12.260Z",
        "historyEventId" : "7b545090-a7f8-4303-8c69-181ed5213095"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c5237a2c-5952-4d2f-a752-c656da0ec9b1",
        "createdDate" : "2019-02-21T21:09:12.260Z",
        "historyEventId" : "ad8990cd-f26b-4401-9d24-d88d8ad3cf90"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:11.889Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:11.845Z",
        "historyEventId" : "347411d4-70ec-4f51-81ad-c0c4b5326a6e"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "caa9e5b4-6e0e-4a76-93a3-a36c9fdf9f84",
        "createdDate" : "2019-02-23T21:09:12.260Z",
        "historyEventId" : "dabbfe25-6a98-4265-9e1b-a280c558d604"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "76c83f85-f03a-47c1-bc16-16d2484724e3",
        "createdDate" : "2019-02-22T21:09:12.260Z",
        "historyEventId" : "42ad5fe3-1c91-4b0d-8af3-7279bfde1892"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d05b171c-ad0d-4d71-99ed-579f88b256c5",
        "createdDate" : "2019-02-21T21:09:12.260Z",
        "historyEventId" : "5524be5c-cac8-4106-a0c8-5e33bf59640d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:11.843Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:11.793Z",
        "historyEventId" : "4cfb18ba-4f01-4ebe-96e2-23ee941b55a0"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "f98519fd-e4c7-46c3-bec6-34f893e5ea35",
        "createdDate" : "2019-02-22T21:09:12.260Z",
        "historyEventId" : "d6192bc9-1456-46b5-9118-131567ba2b5d"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b2421081-31be-4925-966f-56267ec3f479",
        "createdDate" : "2019-02-21T21:09:12.260Z",
        "historyEventId" : "4b1accdd-3918-4ea1-82dd-40063aee3a7d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:11.791Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:09:11.736Z",
        "historyEventId" : "c39cbf20-a7cb-4d6d-8647-9b373a9d2579"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4be89457-e969-4f1c-92ce-05facb3772bf",
        "createdDate" : "2019-02-21T21:09:12.260Z",
        "historyEventId" : "363dc477-56f6-4c09-ba5c-6cee7b9d673c"
      } ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:09:11.735Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/cedc4e36-53ab-4816-bee3-dc60a0dac25d/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/36701577-7900-4f30-897b-3d2872b51773/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" : "6eafded6-dcb9-4aa1-9725-12e9a4e7bf6f",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-12T21:10:13.185Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "84de3263-0b79-44ac-809e-33181fe4b341",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-08T21:10:13.197Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "2b63d45e-4dac-4bcc-82c8-cc9df87ad11b",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-07T21:10:13.197Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "43a55e0b-b23d-46ac-ba6c-af99e98371c4",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-06T21:10:13.197Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "83a09606-8611-472c-815a-659aba96ecf0",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-05T21:10:13.197Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "565d460c-d707-48d3-9124-c2976b632bd7",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-04T21:10:13.197Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "a7f3cc20-ea83-4378-901d-1555edaa7e0d",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-03T21:10:13.197Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "c2b8e304-3cf0-4618-8e3a-8d835d9bcb86",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-02T21:10:13.197Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "353524ce-9f4f-4975-aef4-ea00ba32ac81",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-03-01T21:10:13.197Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "be278efe-a95d-4273-a864-c2df9e32df98",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-28T21:10:13.197Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "cbef54ca-42da-4456-a656-45ae21ff92ad",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-27T21:10:13.197Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "8d368050-6aa9-4fb6-b5ef-5c4cfe5ac9eb",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-26T21:10:13.197Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "e80b30b5-5095-4d26-8ff3-0d8048c6ec76",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-25T21:10:13.197Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "c955cff7-921c-4f34-8380-e82a7dd4a576",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-24T21:10:13.197Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "58b37241-9292-447f-b19e-24cb1f2b8470",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-23T21:10:13.197Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "c9aee666-580e-4305-9a5a-ade3de9e7b30",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-22T21:10:13.197Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "d3e6197c-6409-4746-95f5-55bf6818326f",
      "contentItemId" : "36701577-7900-4f30-897b-3d2872b51773",
      "version" : 1,
      "createdDate" : "2019-02-21T21:10:13.197Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/36701577-7900-4f30-897b-3d2872b51773/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/36701577-7900-4f30-897b-3d2872b51773/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/36701577-7900-4f30-897b-3d2872b51773/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/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/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" : "bc0cfc25-8d58-482b-a0ec-6c3555dd2140",
      "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-03-12T21:09:12.718Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:09:12.767Z",
      "deliveryId" : "bc0cfc25-8d58-482b-a0ec-6c3555dd2140",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff8c9e77c03383e424b"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bc0cfc25-8d58-482b-a0ec-6c3555dd2140"
        }
      }
    }, {
      "id" : "bc0cfc25-8d58-482b-a0ec-6c3555dd2140",
      "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-03-12T21:09:12.718Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:09:12.767Z",
      "deliveryId" : "bc0cfc25-8d58-482b-a0ec-6c3555dd2140",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff8c9e77c03383e424b"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=bc0cfc25-8d58-482b-a0ec-6c3555dd2140"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/bc0cfc25-8d58-482b-a0ec-6c3555dd2140/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=2432112e-44c7-45d0-9a0d-279b91cc0830 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" : "2432112e-44c7-45d0-9a0d-279b91cc0830",
      "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" : "97d85041-90d6-475d-a1c3-ff84ccf431c7"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:11.909Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:11.909Z",
      "deliveryId" : "2432112e-44c7-45d0-9a0d-279b91cc0830",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2432112e-44c7-45d0-9a0d-279b91cc0830"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbbc9e77c03383e2d42"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2432112e-44c7-45d0-9a0d-279b91cc0830",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2432112e-44c7-45d0-9a0d-279b91cc0830{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830/workflow"
        }
      }
    }, {
      "id" : "97d85041-90d6-475d-a1c3-ff84ccf431c7",
      "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" : "1d4d8d22-664d-4299-9571-211b7892125b"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:11.850Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:11.850Z",
      "deliveryId" : "97d85041-90d6-475d-a1c3-ff84ccf431c7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=97d85041-90d6-475d-a1c3-ff84ccf431c7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbbc9e77c03383e2d42"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=97d85041-90d6-475d-a1c3-ff84ccf431c7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=97d85041-90d6-475d-a1c3-ff84ccf431c7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/97d85041-90d6-475d-a1c3-ff84ccf431c7/workflow"
        }
      }
    }, {
      "id" : "1d4d8d22-664d-4299-9571-211b7892125b",
      "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-03-12T21:08:11.787Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:11.787Z",
      "deliveryId" : "1d4d8d22-664d-4299-9571-211b7892125b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=1d4d8d22-664d-4299-9571-211b7892125b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbbc9e77c03383e2d42"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=1d4d8d22-664d-4299-9571-211b7892125b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=1d4d8d22-664d-4299-9571-211b7892125b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1d4d8d22-664d-4299-9571-211b7892125b/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2432112e-44c7-45d0-9a0d-279b91cc0830"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/2432112e-44c7-45d0-9a0d-279b91cc0830{?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/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/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" : "23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e",
  "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-03-12T21:08:11.089Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:11.089Z",
  "deliveryId" : "23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fbac9e77c03383e2cf1"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=23d8c0e1-abc8-4dc0-aaae-95e2bf3cac3e"
    }
  }
}

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/34f7927a-ce8f-471e-81f4-f489cab7a8d1/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" : "34f7927a-ce8f-471e-81f4-f489cab7a8d1",
  "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-03-12T21:08:10.301Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:10.487Z",
  "deliveryId" : "34f7927a-ce8f-471e-81f4-f489cab7a8d1",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/34f7927a-ce8f-471e-81f4-f489cab7a8d1/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fb9c9e77c03383e2ca0"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=34f7927a-ce8f-471e-81f4-f489cab7a8d1"
    }
  }
}

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/680b3666-660e-4cae-9a85-b1c87ec67612/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" : "680b3666-660e-4cae-9a85-b1c87ec67612",
  "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-03-12T21:08:09.125Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:09.517Z",
  "deliveryId" : "680b3666-660e-4cae-9a85-b1c87ec67612",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/680b3666-660e-4cae-9a85-b1c87ec67612/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fb8c9e77c03383e2c50"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=680b3666-660e-4cae-9a85-b1c87ec67612"
    }
  }
}

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/542c22dd-5232-4618-9661-e07fa2b88916/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: Tue, 12 Mar 2019 21:08:51 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3906

{
  "id" : "542c22dd-5232-4618-9661-e07fa2b88916",
  "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-03-12T21:08:50.905Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:51.018Z",
  "deliveryId" : "542c22dd-5232-4618-9661-e07fa2b88916",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=542c22dd-5232-4618-9661-e07fa2b88916"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe2c9e77c03383e3df1"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=542c22dd-5232-4618-9661-e07fa2b88916",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=542c22dd-5232-4618-9661-e07fa2b88916{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/542c22dd-5232-4618-9661-e07fa2b88916/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/5c881feac9e77c03383e3f46/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" : "6ad6ac82-60ce-465b-ac51-e8c91aacd3a4",
      "contentRepositoryId" : "5c881feac9e77c03383e3f47",
      "folderId" : null,
      "deliveryId" : "6ad6ac82-60ce-465b-ac51-e8c91aacd3a4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:59.852Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:59.852Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881feac9e77c03383e3f47"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=6ad6ac82-60ce-465b-ac51-e8c91aacd3a4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=6ad6ac82-60ce-465b-ac51-e8c91aacd3a4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6ad6ac82-60ce-465b-ac51-e8c91aacd3a4/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881feac9e77c03383e3f46/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881feac9e77c03383e3f46/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881feac9e77c03383e3f46/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/5c881fefc9e77c03383e3f95/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" : "66610b90-0e38-45d5-8c28-f3dcb1927722",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "66610b90-0e38-45d5-8c28-f3dcb1927722",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7fb520de-d8bb-4c3a-a861-76bbbe80a04c",
      "createdBy" : "user",
      "createdDate" : "2019-02-11T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-11T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=66610b90-0e38-45d5-8c28-f3dcb1927722",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=66610b90-0e38-45d5-8c28-f3dcb1927722{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66610b90-0e38-45d5-8c28-f3dcb1927722/workflow"
        }
      }
    }, {
      "id" : "b0769ade-faf7-4421-8b5c-38d2e960d84a",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "b0769ade-faf7-4421-8b5c-38d2e960d84a",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3d2dda1b-76b7-435c-becf-83850012fd2c",
      "createdBy" : "user",
      "createdDate" : "2019-02-12T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-12T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b0769ade-faf7-4421-8b5c-38d2e960d84a",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b0769ade-faf7-4421-8b5c-38d2e960d84a{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b0769ade-faf7-4421-8b5c-38d2e960d84a/workflow"
        }
      }
    }, {
      "id" : "8448efc8-f55e-4746-ab34-5116899484d6",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "8448efc8-f55e-4746-ab34-5116899484d6",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "0813a721-ef26-4091-a07f-75cad23f09db",
      "createdBy" : "user",
      "createdDate" : "2019-02-13T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-13T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=8448efc8-f55e-4746-ab34-5116899484d6",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=8448efc8-f55e-4746-ab34-5116899484d6{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/8448efc8-f55e-4746-ab34-5116899484d6/workflow"
        }
      }
    }, {
      "id" : "b4359f67-cb15-43be-9988-d9847bab889f",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "b4359f67-cb15-43be-9988-d9847bab889f",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "fb585f0d-d4d6-43a2-b22c-df87731ea279",
      "createdBy" : "user",
      "createdDate" : "2019-02-14T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-14T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b4359f67-cb15-43be-9988-d9847bab889f",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b4359f67-cb15-43be-9988-d9847bab889f{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b4359f67-cb15-43be-9988-d9847bab889f/workflow"
        }
      }
    }, {
      "id" : "c34b8979-922e-4df0-ba7a-c9d6f3a07add",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "c34b8979-922e-4df0-ba7a-c9d6f3a07add",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d9750bbf-b5eb-4256-a437-eaf370bfc8a9",
      "createdBy" : "user",
      "createdDate" : "2019-02-15T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-15T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c34b8979-922e-4df0-ba7a-c9d6f3a07add",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c34b8979-922e-4df0-ba7a-c9d6f3a07add{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c34b8979-922e-4df0-ba7a-c9d6f3a07add/workflow"
        }
      }
    }, {
      "id" : "afd1d7b6-54bf-4163-aacb-632b50b55508",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "afd1d7b6-54bf-4163-aacb-632b50b55508",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "ca4c9e86-14bf-447f-8c4d-ecf32ff595d3",
      "createdBy" : "user",
      "createdDate" : "2019-02-16T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-16T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=afd1d7b6-54bf-4163-aacb-632b50b55508",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=afd1d7b6-54bf-4163-aacb-632b50b55508{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/afd1d7b6-54bf-4163-aacb-632b50b55508/workflow"
        }
      }
    }, {
      "id" : "b9544d81-5920-4c53-9888-03ba135bdb37",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "b9544d81-5920-4c53-9888-03ba135bdb37",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1cef5708-5053-4cec-a4ea-b218fae34a7b",
      "createdBy" : "user",
      "createdDate" : "2019-02-17T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-17T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b9544d81-5920-4c53-9888-03ba135bdb37",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b9544d81-5920-4c53-9888-03ba135bdb37{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b9544d81-5920-4c53-9888-03ba135bdb37/workflow"
        }
      }
    }, {
      "id" : "f250a9ba-6a1e-4ee4-abdf-17285ab038df",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "f250a9ba-6a1e-4ee4-abdf-17285ab038df",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "7f43df52-ce84-4a83-86ff-ef2d0dcf083f",
      "createdBy" : "user",
      "createdDate" : "2019-02-18T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-18T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f250a9ba-6a1e-4ee4-abdf-17285ab038df",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f250a9ba-6a1e-4ee4-abdf-17285ab038df{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f250a9ba-6a1e-4ee4-abdf-17285ab038df/workflow"
        }
      }
    }, {
      "id" : "c5c0933d-412f-4a3b-b7b6-2b359de4f3e5",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "c5c0933d-412f-4a3b-b7b6-2b359de4f3e5",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "f8fb443d-63c3-4f53-8332-6f8345805f0f",
      "createdBy" : "user",
      "createdDate" : "2019-02-19T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-19T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c5c0933d-412f-4a3b-b7b6-2b359de4f3e5",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c5c0933d-412f-4a3b-b7b6-2b359de4f3e5{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c5c0933d-412f-4a3b-b7b6-2b359de4f3e5/workflow"
        }
      }
    }, {
      "id" : "ade32ae7-aede-422e-beed-a5fc65e7e49b",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "ade32ae7-aede-422e-beed-a5fc65e7e49b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "1a9564fd-bcf4-4203-8cc7-9a01b77e321b",
      "createdBy" : "user",
      "createdDate" : "2019-02-20T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-20T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ade32ae7-aede-422e-beed-a5fc65e7e49b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ade32ae7-aede-422e-beed-a5fc65e7e49b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ade32ae7-aede-422e-beed-a5fc65e7e49b/workflow"
        }
      }
    }, {
      "id" : "692c9861-8c8a-4320-abf5-7a850efcd4b4",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "692c9861-8c8a-4320-abf5-7a850efcd4b4",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "403e9711-368c-4c74-b266-9cfcb5bf2bb9",
      "createdBy" : "user",
      "createdDate" : "2019-02-21T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-21T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=692c9861-8c8a-4320-abf5-7a850efcd4b4",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=692c9861-8c8a-4320-abf5-7a850efcd4b4{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/692c9861-8c8a-4320-abf5-7a850efcd4b4/workflow"
        }
      }
    }, {
      "id" : "ca25df92-5fac-407c-8cd2-f373b3f75d31",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "ca25df92-5fac-407c-8cd2-f373b3f75d31",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "692155e4-66ea-448e-9643-8aff49490895",
      "createdBy" : "user",
      "createdDate" : "2019-02-22T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-22T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ca25df92-5fac-407c-8cd2-f373b3f75d31",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ca25df92-5fac-407c-8cd2-f373b3f75d31{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca25df92-5fac-407c-8cd2-f373b3f75d31/workflow"
        }
      }
    }, {
      "id" : "f2aedb05-8404-49f3-aa03-1b18a969a86d",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "f2aedb05-8404-49f3-aa03-1b18a969a86d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "0643f4db-0985-4d1c-a96d-d17ca67f4ae7",
      "createdBy" : "user",
      "createdDate" : "2019-02-23T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-23T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f2aedb05-8404-49f3-aa03-1b18a969a86d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f2aedb05-8404-49f3-aa03-1b18a969a86d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f2aedb05-8404-49f3-aa03-1b18a969a86d/workflow"
        }
      }
    }, {
      "id" : "4325cbb8-dbec-4026-b01e-01ead48f343e",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "4325cbb8-dbec-4026-b01e-01ead48f343e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b0f11f8a-471c-4b02-b38e-bab2e02857cd",
      "createdBy" : "user",
      "createdDate" : "2019-02-24T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-24T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=4325cbb8-dbec-4026-b01e-01ead48f343e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=4325cbb8-dbec-4026-b01e-01ead48f343e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4325cbb8-dbec-4026-b01e-01ead48f343e/workflow"
        }
      }
    }, {
      "id" : "f617b8f3-720f-4c3b-ad6c-5fbf36813d1d",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "f617b8f3-720f-4c3b-ad6c-5fbf36813d1d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "9bef293f-3e75-4273-80c7-fb6391d365ec",
      "createdBy" : "user",
      "createdDate" : "2019-02-25T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-25T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f617b8f3-720f-4c3b-ad6c-5fbf36813d1d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f617b8f3-720f-4c3b-ad6c-5fbf36813d1d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f617b8f3-720f-4c3b-ad6c-5fbf36813d1d/workflow"
        }
      }
    }, {
      "id" : "a3c4979c-7057-487f-afe7-fd6f547314e1",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "a3c4979c-7057-487f-afe7-fd6f547314e1",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "99293b10-2790-4f12-96b8-1b0aa82b96a3",
      "createdBy" : "user",
      "createdDate" : "2019-02-26T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-26T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a3c4979c-7057-487f-afe7-fd6f547314e1",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a3c4979c-7057-487f-afe7-fd6f547314e1{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/a3c4979c-7057-487f-afe7-fd6f547314e1/workflow"
        }
      }
    }, {
      "id" : "61f79c82-0a36-487c-b9ec-9a82dbb093cb",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "61f79c82-0a36-487c-b9ec-9a82dbb093cb",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "fe6a82ad-a085-49d3-8b2a-f4d9ff94c534",
      "createdBy" : "user",
      "createdDate" : "2019-02-27T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-27T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=61f79c82-0a36-487c-b9ec-9a82dbb093cb",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=61f79c82-0a36-487c-b9ec-9a82dbb093cb{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/61f79c82-0a36-487c-b9ec-9a82dbb093cb/workflow"
        }
      }
    }, {
      "id" : "dc42fd5d-7ec4-416d-92f9-4f05193d8f0b",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "dc42fd5d-7ec4-416d-92f9-4f05193d8f0b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b59f5fc0-ee91-4dec-bd66-11a261c9e683",
      "createdBy" : "user",
      "createdDate" : "2019-02-28T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-02-28T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=dc42fd5d-7ec4-416d-92f9-4f05193d8f0b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=dc42fd5d-7ec4-416d-92f9-4f05193d8f0b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dc42fd5d-7ec4-416d-92f9-4f05193d8f0b/workflow"
        }
      }
    }, {
      "id" : "7d1a7981-88cb-49e5-91f7-8157f7adbf9b",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "7d1a7981-88cb-49e5-91f7-8157f7adbf9b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d6b1d45b-ca5f-48e1-9cdd-4154daca17a8",
      "createdBy" : "user",
      "createdDate" : "2019-03-01T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-01T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7d1a7981-88cb-49e5-91f7-8157f7adbf9b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7d1a7981-88cb-49e5-91f7-8157f7adbf9b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d1a7981-88cb-49e5-91f7-8157f7adbf9b/workflow"
        }
      }
    }, {
      "id" : "e94b08e6-9262-43ba-a0d6-a563eaab53ea",
      "contentRepositoryId" : "5c881fefc9e77c03383e3f9b",
      "folderId" : null,
      "deliveryId" : "e94b08e6-9262-43ba-a0d6-a563eaab53ea",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "19698180-943a-4665-9df4-c0339876817b",
      "createdBy" : "user",
      "createdDate" : "2019-03-02T21:09:03.523Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-02T21:09:03.523Z",
      "_links" : {
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/publish"
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/planned{?epoch,time}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fefc9e77c03383e3f9b"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e94b08e6-9262-43ba-a0d6-a563eaab53ea",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e94b08e6-9262-43ba-a0d6-a563eaab53ea{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e94b08e6-9262-43ba-a0d6-a563eaab53ea/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fefc9e77c03383e3f95/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fefc9e77c03383e3f95/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fefc9e77c03383e3f95/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881fefc9e77c03383e3f95/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/2ad0ce4a-d02a-4551-b269-e585df5476ce/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/5c881fe1c9e77c03383e3d00

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/5668c9b5-9614-488b-b33a-137bd0d43d30/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: 1486

{
  "contentItemId" : "5668c9b5-9614-488b-b33a-137bd0d43d30",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5c881fe2c9e77c03383e3d9a",
    "eventStart" : "2019-03-12T21:08:23.517Z",
    "eventEnd" : "2019-04-12T21:08:23.517Z",
    "editionTitle" : "Test",
    "editionId" : "5c881fe2c9e77c03383e3d9b",
    "editionStart" : "2019-03-12T21:08:23.517Z",
    "editionEnd" : "2019-04-12T21:08:23.517Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5c881fe2c9e77c03383e3da0",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2019-03-12T21:08:50.481Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2019-03-12T21:08:50.45Z",
    "snapshotId" : "5c881fe2c9e77c03383e3da6",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5c881fe2c9e77c03383e3d9b/slots/5c881fe2c9e77c03383e3da0"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5c881fe2c9e77c03383e3d9b/slots/5c881fe2c9e77c03383e3da0/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5668c9b5-9614-488b-b33a-137bd0d43d30/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/5aebc7df-1c70-4d7c-a13f-cbf05e904920/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5aebc7df-1c70-4d7c-a13f-cbf05e904920",
  "workflow" : {
    "state" : "5c882042c9e77c03383e4f8f"
  },
  "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-03-12T21:10:26.479Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:10:26.526Z",
  "deliveryId" : "5aebc7df-1c70-4d7c-a13f-cbf05e904920",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5aebc7df-1c70-4d7c-a13f-cbf05e904920"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c882042c9e77c03383e4f8d"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5aebc7df-1c70-4d7c-a13f-cbf05e904920",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5aebc7df-1c70-4d7c-a13f-cbf05e904920{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5aebc7df-1c70-4d7c-a13f-cbf05e904920/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/5c88203ec9e77c03383e4bbd/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/5c88203ec9e77c03383e4bbe
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1137

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

Get an Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Get an Event with Editions

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5c88203ec9e77c03383e4bbd/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: 1939

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

{
  "name" : "shoes",
  "start" : "2019-03-12T22:10:22.323Z",
  "end" : "2019-03-13T01:10:22.323Z",
  "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/5c88203ec9e77c03383e4b2a
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1120

{
  "id" : "5c88203ec9e77c03383e4b2a",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2019-03-12T22:10:22.323Z",
  "end" : "2019-03-13T01:10:22.323Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203ec9e77c03383e4b29"
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a/editions{?page,size,sort}",
      "templated" : true
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4b2a/editions{?sourceEditionId}",
      "templated" : true
    }
  }
}

Delete an Event

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - DELETE_EVENT

Example request

DELETE /v2/content/events/5c88203ec9e77c03383e4b74 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=5c882036c9e77c03383e43c7&rangeEnd=2019-03-15T21:10:13.977Z&rangeStart=2019-03-09T21:10:13.977Z&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: 7290

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c882036c9e77c03383e43cf",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2019-03-06T21:10:13.977Z",
      "end" : "2019-03-09T21:10:13.977Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43c7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cf/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c882036c9e77c03383e43cd",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2019-03-06T21:10:13.977Z",
      "end" : "2019-03-10T21:10:13.977Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43c7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cd/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c882036c9e77c03383e43cb",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-03-12T21:10:13.977Z",
      "end" : "2019-03-14T21:10:13.977Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43c7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cb/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c882036c9e77c03383e43cc",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2019-03-14T21:10:13.977Z",
      "end" : "2019-03-18T21:10:13.977Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43c7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43cc/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c882036c9e77c03383e43ce",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2019-03-15T21:10:13.977Z",
      "end" : "2019-03-18T21:10:13.977Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43c7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43ce/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c882036c9e77c03383e43c7&rangeStart=2019-03-09T21:10:13.977Z&rangeEnd=2019-03-15T21:10:13.977Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c882036c9e77c03383e43c7&rangeStart=2019-03-09T21:10:13.977Z&rangeEnd=2019-03-15T21:10:13.977Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c882036c9e77c03383e43c7&rangeStart=2019-03-09T21:10:13.977Z&rangeEnd=2019-03-15T21:10:13.977Z&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=5c88203dc9e77c03383e4ac9&rangeEnd=2019-03-15T21:10:21.373Z&rangeStart=2019-03-09T21:10:21.373Z&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: 3019

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c88203dc9e77c03383e4aca",
      "name" : "My Event #1",
      "comment" : "This is an event.",
      "start" : "2019-03-13T21:10:21.373Z",
      "end" : "2019-03-14T21:10:21.373Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5c88203dc9e77c03383e4acb",
        "name" : "My Edition",
        "comment" : "This is an example edition.",
        "start" : "2019-03-13T21:10:21.373Z",
        "end" : "2019-03-14T21:10:21.373Z",
        "eventId" : "5c88203dc9e77c03383e4aca",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 200,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:21.567Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:21.568Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:21.568Z",
        "stagedDate" : null,
        "slotCollisions" : false
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ac9"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4aca/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ac9&rangeStart=2019-03-09T21:10:21.373Z&rangeEnd=2019-03-15T21:10:21.373Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ac9&rangeStart=2019-03-09T21:10:21.373Z&rangeEnd=2019-03-15T21:10:21.373Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ac9&rangeStart=2019-03-09T21:10:21.373Z&rangeEnd=2019-03-15T21:10:21.373Z&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=5c88203dc9e77c03383e4ad0&rangeStart=2019-03-12T21:10:21.760Z&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: 4660

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c88203dc9e77c03383e4ad4",
      "name" : "Active Event",
      "comment" : "This is an event.",
      "start" : "2019-03-10T21:10:21.760Z",
      "end" : "2019-03-14T21:10:21.760Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ad0"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad4/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c88203dc9e77c03383e4ad3",
      "name" : "Starting Event",
      "comment" : "This is an event.",
      "start" : "2019-03-12T21:10:21.760Z",
      "end" : "2019-03-14T21:10:21.760Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ad0"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad3/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c88203dc9e77c03383e4ad2",
      "name" : "Future Event",
      "comment" : "This is an event.",
      "start" : "2019-03-13T21:10:21.760Z",
      "end" : "2019-03-14T21:10:21.760Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ad0"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4ad2/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad0&rangeStart=2019-03-12T21:10:21.760Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad0&rangeStart=2019-03-12T21:10:21.760Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad0&rangeStart=2019-03-12T21:10:21.760Z&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=5c88203dc9e77c03383e4ad7&rangeEnd=2019-03-11T23: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: 2218

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

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

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c88203ec9e77c03383e4add",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2019-03-13T00:00:00.000Z",
      "end" : "2019-03-13T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ad7"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203ec9e77c03383e4add/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad7&rangeStart=2019-03-13T00:00:00.000Z&rangeEnd=2019-03-13T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad7&rangeStart=2019-03-13T00:00:00.000Z&rangeEnd=2019-03-13T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5c88203dc9e77c03383e4ad7&rangeStart=2019-03-13T00:00:00.000Z&rangeEnd=2019-03-13T23: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=5c88203dc9e77c03383e4ab8&rangeEnd=2019-03-15T21:10:21.010Z&rangeStart=2019-03-09T21:10:21.010Z&bounded=0&slots=b8a17a92-cd8c-492a-b86e-ad97f49892fc&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: 2432

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c88203dc9e77c03383e4abc",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-03-12T21:10:21.010Z",
      "end" : "2019-03-14T21:10:21.010Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203dc9e77c03383e4ab8"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88203dc9e77c03383e4abc/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c88203dc9e77c03383e4ab8&rangeStart=2019-03-09T21:10:21.010Z&rangeEnd=2019-03-15T21:10:21.010Z&bounded=false&slots=b8a17a92-cd8c-492a-b86e-ad97f49892fc&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c88203dc9e77c03383e4ab8&rangeStart=2019-03-09T21:10:21.010Z&rangeEnd=2019-03-15T21:10:21.010Z&bounded=false&slots=b8a17a92-cd8c-492a-b86e-ad97f49892fc&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c88203dc9e77c03383e4ab8&rangeStart=2019-03-09T21:10:21.010Z&rangeEnd=2019-03-15T21:10:21.010Z&bounded=false&slots=b8a17a92-cd8c-492a-b86e-ad97f49892fc&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=5c882036c9e77c03383e43d2&rangeEnd=2019-03-15T21:10:14.491Z&rangeStart=2019-03-09T21:10:14.491Z&bounded=0&projection=withEditions&slots=5e3efa5f-f570-4d4d-b32e-f25619da53d6&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: 40499

{
  "_embedded" : {
    "events" : [ {
      "id" : "5c882036c9e77c03383e43d8",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2019-03-12T21:10:14.491Z",
      "end" : "2019-03-14T21:10:14.491Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5c882036c9e77c03383e43d9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.676Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.677Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.709Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43db",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.728Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.728Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.756Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43de",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.769Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.769Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.798Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43e2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.811Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.811Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.843Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43e7",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.859Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.860Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.892Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43ed",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.906Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.906Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.938Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43f4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.951Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.952Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:14.984Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882036c9e77c03383e43fc",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:14.998Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:14.999Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.031Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4405",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.044Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.044Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.078Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e440f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.093Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.094Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.147Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e441a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.164Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.165Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.204Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4426",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.218Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.219Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.256Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4433",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.271Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.271Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.311Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4441",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.324Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.325Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.366Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4450",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.379Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.379Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.420Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4460",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.435Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.436Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.477Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4471",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.491Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.492Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.537Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4483",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.551Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.551Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.596Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4496",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.609Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.610Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.660Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e44aa",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.675Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.675Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.724Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e44bf",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.737Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.738Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.789Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e44d5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.802Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.803Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.852Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e44ec",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.866Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.867Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.922Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882037c9e77c03383e4504",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:15.934Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:15.935Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:15.987Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e451d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.001Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.002Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.054Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e4537",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.067Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.068Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.126Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e4552",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.139Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.139Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.195Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e456e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.208Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.209Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.263Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e458b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.276Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.277Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.332Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e45a9",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.345Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.346Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.413Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e45c8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.429Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.430Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.498Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e45e8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.516Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.517Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.580Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e4609",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.600Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.601Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.684Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e462b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.701Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.702Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.786Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e464e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.803Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.804Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.888Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e4672",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.906Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.907Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:16.970Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882038c9e77c03383e4697",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:16.984Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:16.984Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.046Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e46bd",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.059Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.059Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.123Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e46e4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.135Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.136Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.199Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e470c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.212Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.213Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.276Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e4735",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.290Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.291Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.370Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e475f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.384Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.384Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.451Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e478a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.465Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.466Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.538Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e47b6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.552Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.552Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.619Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e47e3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.638Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.639Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.721Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e4811",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.739Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.739Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.835Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e4840",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.851Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.852Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:17.926Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c882039c9e77c03383e4870",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:17.940Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:17.941Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:18.013Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c88203ac9e77c03383e48a1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:18.025Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:18.027Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:18.095Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5c88203ac9e77c03383e48d3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2019-03-12T21:10:14.491Z",
        "end" : "2019-03-14T21:10:14.491Z",
        "eventId" : "5c882036c9e77c03383e43d8",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2019-03-12T21:10:18.110Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2019-03-12T21:10:18.111Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2019-03-12T21:10:18.179Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882036c9e77c03383e43d2"
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8/editions{?page,size,sort}",
          "templated" : true
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5c882036c9e77c03383e43d8/editions{?sourceEditionId}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c882036c9e77c03383e43d2&rangeStart=2019-03-09T21:10:14.491Z&rangeEnd=2019-03-15T21:10:14.491Z&bounded=false&slots=5e3efa5f-f570-4d4d-b32e-f25619da53d6&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c882036c9e77c03383e43d2&rangeStart=2019-03-09T21:10:14.491Z&rangeEnd=2019-03-15T21:10:14.491Z&bounded=false&slots=5e3efa5f-f570-4d4d-b32e-f25619da53d6&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5c882036c9e77c03383e43d2&rangeStart=2019-03-09T21:10:14.491Z&rangeEnd=2019-03-15T21:10:14.491Z&bounded=false&slots=5e3efa5f-f570-4d4d-b32e-f25619da53d6&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/5c88203ec9e77c03383e4bbe/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: Tue, 12 Mar 2019 21:10:22 GMT
Location: https://api.amplience.net/v2/content/editions/5c88203ec9e77c03383e4bbf
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

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

{
  "name" : "Test",
  "start" : "2019-03-12T21:08:23.517Z",
  "end" : "2019-04-12T21:08:23.517Z",
  "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: Tue, 12 Mar 2019 21:11:11 GMT
Location: https://api.amplience.net/v2/content/editions/5c88206fc9e77c03383e5e4b
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2619

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

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:10:22 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

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

{
  "name" : "New Name",
  "start" : "2019-03-12T21:08:23.517Z",
  "end" : "2019-03-18T21:08:23.517Z",
  "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: Tue, 12 Mar 2019 21:10:34 GMT
Location: https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2545

{
  "id" : "5c88204ac9e77c03383e59da",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2019-03-12T21:08:23.517Z",
  "end" : "2019-03-18T21:08:23.517Z",
  "eventId" : "5c88204ac9e77c03383e59d9",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2019-03-12T21:10:34.225Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:10:34.226Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:10:34.249Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5c88204ac9e77c03383e59d9"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88204ac9e77c03383e59da/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/5c88206fc9e77c03383e5e9a 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/5c88205ac9e77c03383e5af1/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2019-03-12T21:10:50.857Z"
}

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

{
  "lastModifiedDate" : "2019-03-12T21:11:09.643Z",
  "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" : "5c88206dc9e77c03383e5d42"
}

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/5c88206ec9e77c03383e5d98/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" : "5c88206ec9e77c03383e5da3"
}

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

Example response

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

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

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5c88206ec9e77c03383e5def",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2019-03-12T21:08:23.517Z",
      "end" : "2019-03-12T23:08:23.517Z",
      "eventId" : "5c88206ec9e77c03383e5ded",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-03-12T21:11:10.540Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:11:10.540Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:11:10.540Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88206ec9e77c03383e5ded"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5def/slot-collisions"
        }
      }
    }, {
      "id" : "5c88206ec9e77c03383e5dee",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2019-03-12T22:08:23.517Z",
      "end" : "2019-03-12T23:08:23.517Z",
      "eventId" : "5c88206ec9e77c03383e5ded",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-03-12T21:11:10.528Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:11:10.529Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:11:10.529Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88206ec9e77c03383e5ded"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5dee/slot-collisions"
        }
      }
    }, {
      "id" : "5c88206ec9e77c03383e5df0",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2019-03-12T22:08:24.517Z",
      "end" : "2019-03-12T23:08:23.517Z",
      "eventId" : "5c88206ec9e77c03383e5ded",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2019-03-12T21:11:10.551Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:11:10.552Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:11:10.552Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5c88206ec9e77c03383e5ded"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c88206ec9e77c03383e5df0/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c88206ec9e77c03383e5ded&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c88206ec9e77c03383e5ded&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5c88206ec9e77c03383e5ded&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/5c88205bc9e77c03383e5b58/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" : "d500494c-309c-4e9d-b02c-95e18ce3cea3",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5b58/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5b58"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5b58/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/5c88205bc9e77c03383e5bb4/conflicts/findByIdAndVersion?id=9e6c07e9-0ec2-4fe2-8613-02ff82f6e9ad&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" : "5c88205bc9e77c03383e5bb4",
  "contentItemId" : "9e6c07e9-0ec2-4fe2-8613-02ff82f6e9ad",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5c88205bc9e77c03383e5bb5",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:10:51.882Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5c88205bc9e77c03383e5bb7",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "9e6c07e9-0ec2-4fe2-8613-02ff82f6e9ad",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5bb4/conflicts/findByIdAndVersion?id=9e6c07e9-0ec2-4fe2-8613-02ff82f6e9ad&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5bb4"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88205bc9e77c03383e5bb4/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/5c88205cc9e77c03383e5c0b/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-03-12T21:10:52.641Z",
  "resolutions" : [ {
    "contentItemId" : "bedb4f30-03db-452d-bc19-35df6115b4a2",
    "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/5c88206fc9e77c03383e5eed/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" : "5c88206fc9e77c03383e5eed",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2019-03-12T21:08:23.517Z",
    "endDateTime" : "2019-04-12T21:08:23.517Z",
    "editionId" : "5c88206fc9e77c03383e5ee8",
    "collidingSlotIds" : [ "8b22b7e9-bcec-4980-94e9-c15acf22f633", "b5f5988f-e808-460b-ae33-702e7e6446b6" ],
    "eventName" : "Test",
    "eventId" : "5c88206fc9e77c03383e5ee7"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88206fc9e77c03383e5eed/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c88206fc9e77c03383e5eed/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/5c881fc8c9e77c03383e38d8/slots?sourceEditionSlotId=5c881fc8c9e77c03383e38d6 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5c881fc8c9e77c03383e38d6

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:08:24 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1652

{
  "id" : "5c881fc8c9e77c03383e38d9",
  "eventId" : "5c881fc8c9e77c03383e38d7",
  "editionId" : "5c881fc8c9e77c03383e38d8",
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:08:24.319Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:24.319Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c881fc7c9e77c03383e38ce",
  "slotId" : "b65ecafd-be9e-4b7f-949e-8512c6f20a1d",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc8c9e77c03383e38d8/slots/5c881fc8c9e77c03383e38d9"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc8c9e77c03383e38d8/slots/5c881fc8c9e77c03383e38d9"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc8c9e77c03383e38d8"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b65ecafd-be9e-4b7f-949e-8512c6f20a1d{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc8c9e77c03383e38d8/slots/5c881fc8c9e77c03383e38d9/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc8c9e77c03383e38d8/slots/5c881fc8c9e77c03383e38d9/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/5c881fdbc9e77c03383e3a34/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: Tue, 12 Mar 2019 21:08:43 GMT
Location: https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "fc33b05e-214a-40e0-a348-5972f08d42cc",
  "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-03-12T21:08:43.199Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:43.199Z",
  "deliveryId" : "fc33b05e-214a-40e0-a348-5972f08d42cc",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fc33b05e-214a-40e0-a348-5972f08d42cc"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fdbc9e77c03383e3a34"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fc33b05e-214a-40e0-a348-5972f08d42cc",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fc33b05e-214a-40e0-a348-5972f08d42cc{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc/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/5c881fdcc9e77c03383e3a9d/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 167

[ {
  "slot" : "b3c13e0d-67ac-41a0-9d9e-0e584031d71d"
}, {
  "slot" : "88004395-79af-407e-a8e3-b24a87bcb432"
}, {
  "slot" : "c4e87279-e656-4bbc-94c1-5a0edcc3673d"
} ]

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

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5c881fdcc9e77c03383e3aa3",
      "eventId" : "5c881fdcc9e77c03383e3a9c",
      "editionId" : "5c881fdcc9e77c03383e3a9d",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:44.541Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:44.541Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c881fdcc9e77c03383e3a9b",
      "slotId" : "b3c13e0d-67ac-41a0-9d9e-0e584031d71d",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa3"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa3"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3c13e0d-67ac-41a0-9d9e-0e584031d71d{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa3/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa3/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fdcc9e77c03383e3aa1",
      "eventId" : "5c881fdcc9e77c03383e3a9c",
      "editionId" : "5c881fdcc9e77c03383e3a9d",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:44.539Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:44.539Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c881fdcc9e77c03383e3a9b",
      "slotId" : "88004395-79af-407e-a8e3-b24a87bcb432",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa1"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa1"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/88004395-79af-407e-a8e3-b24a87bcb432{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa1/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa1/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fdcc9e77c03383e3aa2",
      "eventId" : "5c881fdcc9e77c03383e3a9c",
      "editionId" : "5c881fdcc9e77c03383e3a9d",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:44.540Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:44.540Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c881fdcc9e77c03383e3a9b",
      "slotId" : "c4e87279-e656-4bbc-94c1-5a0edcc3673d",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa2"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa2"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4e87279-e656-4bbc-94c1-5a0edcc3673d{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa2/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots/5c881fdcc9e77c03383e3aa2/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdcc9e77c03383e3a9d/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/5c881fdbc9e77c03383e3a91/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" : "5c881fdcc9e77c03383e3a97",
      "eventId" : "5c881fdbc9e77c03383e3a90",
      "editionId" : "5c881fdbc9e77c03383e3a91",
      "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" : "5c881fdbc9e77c03383e3a8f",
      "slotId" : "3ea2e400-1489-4ae3-a275-ba6013927b73",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a97"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a97"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ea2e400-1489-4ae3-a275-ba6013927b73{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a97/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a97/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fdcc9e77c03383e3a95",
      "eventId" : "5c881fdbc9e77c03383e3a90",
      "editionId" : "5c881fdbc9e77c03383e3a91",
      "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" : "5c881fdbc9e77c03383e3a8f",
      "slotId" : "22b942eb-df20-4a18-9704-c8d767f6ed6a",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a95"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a95"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/22b942eb-df20-4a18-9704-c8d767f6ed6a{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a95/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdcc9e77c03383e3a95/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c881fdbc9e77c03383e3a93",
      "eventId" : "5c881fdbc9e77c03383e3a90",
      "editionId" : "5c881fdbc9e77c03383e3a91",
      "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" : "5c881fdbc9e77c03383e3a8f",
      "slotId" : "aa6122d0-32db-4051-95fa-2dd08a801202",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdbc9e77c03383e3a93"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdbc9e77c03383e3a93"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/aa6122d0-32db-4051-95fa-2dd08a801202{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdbc9e77c03383e3a93/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots/5c881fdbc9e77c03383e3a93/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a91/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/5c881fddc9e77c03383e3af4/slots?includedSlots=5a05fbea-0233-42aa-b180-1e59dd5abab7 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5c881fddc9e77c03383e3af5",
      "eventId" : "5c881fdcc9e77c03383e3af0",
      "editionId" : "5c881fddc9e77c03383e3af4",
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:08:45.066Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2019-03-12T21:08:45.066Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5c881fdcc9e77c03383e3aef",
      "slotId" : "5a05fbea-0233-42aa-b180-1e59dd5abab7",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots/5c881fddc9e77c03383e3af5"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots/5c881fddc9e77c03383e3af5"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5a05fbea-0233-42aa-b180-1e59dd5abab7{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots/5c881fddc9e77c03383e3af5/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots/5c881fddc9e77c03383e3af5/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots?includedSlots=5a05fbea-0233-42aa-b180-1e59dd5abab7&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots?includedSlots=5a05fbea-0233-42aa-b180-1e59dd5abab7&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fddc9e77c03383e3af4/slots?includedSlots=5a05fbea-0233-42aa-b180-1e59dd5abab7&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/5c881fc9c9e77c03383e3928/slots/5c881fc9c9e77c03383e392a HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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" : "5c881fc9c9e77c03383e392a",
  "eventId" : "5c881fc9c9e77c03383e3927",
  "editionId" : "5c881fc9c9e77c03383e3928",
  "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" : "5c881fc9c9e77c03383e3926",
  "slotId" : "91681cb0-a297-429d-9980-7aceb05a6247",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc9c9e77c03383e3928/slots/5c881fc9c9e77c03383e392a"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc9c9e77c03383e3928/slots/5c881fc9c9e77c03383e392a"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc9c9e77c03383e3928"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/91681cb0-a297-429d-9980-7aceb05a6247{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc9c9e77c03383e3928/slots/5c881fc9c9e77c03383e392a/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fc9c9e77c03383e3928/slots/5c881fc9c9e77c03383e392a/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/5c881fc9c9e77c03383e3978/slots/5c881fc9c9e77c03383e397a 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/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36/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" : "224b88cd-1db4-4f7f-8545-713226cedadf",
        "locked" : true
      },
      "id" : "5c881fdbc9e77c03383e3a3c",
      "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: Tue, 12 Mar 2019 21:08:43 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5c881fdbc9e77c03383e3a36",
  "eventId" : "5c881fdbc9e77c03383e3a30",
  "editionId" : "5c881fdbc9e77c03383e3a31",
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:08:43.233Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:43.484Z",
  "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" : "224b88cd-1db4-4f7f-8545-713226cedadf",
          "locked" : true
        },
        "id" : "5c881fdbc9e77c03383e3a3c",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c881fdbc9e77c03383e3a33",
  "slotId" : "fc33b05e-214a-40e0-a348-5972f08d42cc",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36/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/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:08:43 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5c881fdbc9e77c03383e3a36",
  "eventId" : "5c881fdbc9e77c03383e3a30",
  "editionId" : "5c881fdbc9e77c03383e3a31",
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:08:43.233Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:43.484Z",
  "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" : "224b88cd-1db4-4f7f-8545-713226cedadf",
          "locked" : true
        },
        "id" : "5c881fdbc9e77c03383e3a3c",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5c881fdbc9e77c03383e3a33",
  "slotId" : "fc33b05e-214a-40e0-a348-5972f08d42cc",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/fc33b05e-214a-40e0-a348-5972f08d42cc{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdbc9e77c03383e3a31/slots/5c881fdbc9e77c03383e3a36/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/5c881fdac9e77c03383e3a29/slots/5c881fdac9e77c03383e3a2e HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:08:42 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1702

{
  "id" : "5c881fdac9e77c03383e3a2e",
  "eventId" : "5c881fdac9e77c03383e3a28",
  "editionId" : "5c881fdac9e77c03383e3a29",
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:08:42.792Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:42.882Z",
  "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" : "5c881fdac9e77c03383e3a2b",
  "slotId" : "c108a004-9590-4505-bbc1-e7a0a57f6830",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdac9e77c03383e3a29/slots/5c881fdac9e77c03383e3a2e"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdac9e77c03383e3a29/slots/5c881fdac9e77c03383e3a2e"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdac9e77c03383e3a29"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c108a004-9590-4505-bbc1-e7a0a57f6830{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdac9e77c03383e3a29/slots/5c881fdac9e77c03383e3a2e/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c881fdac9e77c03383e3a29/slots/5c881fdac9e77c03383e3a2e/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/5c882047c9e77c03383e5865/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" : "a5419c11-36fa-4226-ae70-691c5cdbea9b",
  "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/5c882047c9e77c03383e586c
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5c882047c9e77c03383e586c",
  "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" : "a5419c11-36fa-4226-ae70-691c5cdbea9b"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882047c9e77c03383e5865"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a5419c11-36fa-4226-ae70-691c5cdbea9b"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e586c/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

{
  "_embedded" : {
    "snapshots" : [ {
      "id" : "5c882049c9e77c03383e5982",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-03-12T21:10:33.762Z",
      "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" : "11de58fc-5205-46c5-a5c1-92120501c0c1"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/11de58fc-5205-46c5-a5c1-92120501c0c1"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5982/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5c882049c9e77c03383e5983",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2019-03-12T21:10:33.773Z",
      "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" : "790946f1-ec6f-44a2-a36d-f339a768e0a1"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/790946f1-ec6f-44a2-a36d-f339a768e0a1"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5983/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882049c9e77c03383e597b/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/5c882047c9e77c03383e58bb HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5c882047c9e77c03383e58bb",
  "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" : "b4fee95e-2bdb-4456-98e3-977571084ee3"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882047c9e77c03383e58b5"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b4fee95e-2bdb-4456-98e3-977571084ee3"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882047c9e77c03383e58bb/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/5c882049c9e77c03383e5931/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

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

{
  "editionId" : "5c882049c9e77c03383e5930",
  "createdDate" : "2019-03-12T21:10:33Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5c882049c9e77c03383e5930"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882049c9e77c03383e5931/edition-links/5c882049c9e77c03383e5930"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5c882048c9e77c03383e590c/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" : "5c882048c9e77c03383e5912",
      "createdDate" : "2019-03-12T21:10:32Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c882048c9e77c03383e5912"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links/5c882048c9e77c03383e5912"
        }
      }
    }, {
      "editionId" : "5c882048c9e77c03383e5913",
      "createdDate" : "2019-03-12T21:10:33Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c882048c9e77c03383e5913"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links/5c882048c9e77c03383e5913"
        }
      }
    }, {
      "editionId" : "5c882048c9e77c03383e5914",
      "createdDate" : "2019-03-12T21:10:33Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c882048c9e77c03383e5914"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links/5c882048c9e77c03383e5914"
        }
      }
    }, {
      "editionId" : "5c882048c9e77c03383e5915",
      "createdDate" : "2019-03-12T21:10:33Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c882048c9e77c03383e5915"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links/5c882048c9e77c03383e5915"
        }
      }
    }, {
      "editionId" : "5c882048c9e77c03383e5916",
      "createdDate" : "2019-03-12T21:10:33Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5c882048c9e77c03383e5916"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links/5c882048c9e77c03383e5916"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882048c9e77c03383e590c/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/5c882071c9e77c03383e6027/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 50

{
  "scheduledDate" : "2019-03-12T22:11:13.061Z"
}
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/5c882071c9e77c03383e6028
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5c882071c9e77c03383e6028",
  "scheduledDate" : "2019-03-12T22:11:13.061Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882071c9e77c03383e6028"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882071c9e77c03383e6028"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882071c9e77c03383e6027"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882071c9e77c03383e6028"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/publishing-jobs/5c882070c9e77c03383e5fd8 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5c882070c9e77c03383e5fd8",
  "scheduledDate" : "2019-03-12T23:11:12.488Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882070c9e77c03383e5fd8"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882070c9e77c03383e5fd8"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882070c9e77c03383e5fd7"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882070c9e77c03383e5fd8"
    }
  }
}

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/5c882071c9e77c03383e6078 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" : "5c882071c9e77c03383e6078",
  "scheduledDate" : "2019-04-12T21:11:13.438Z",
  "createdDate" : "2019-03-12T21:11:13.450Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882071c9e77c03383e6078"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5c882071c9e77c03383e6078"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5c882071c9e77c03383e6077"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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

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

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

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

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

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/5c881fe3c9e77c03383e3e4a/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: Tue, 12 Mar 2019 21:08:51 GMT
Location: https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3928

{
  "id" : "0deb415e-a725-4b88-ac60-8c7ba52ee7b0",
  "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-03-12T21:08:51.671Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:51.671Z",
  "deliveryId" : "0deb415e-a725-4b88-ac60-8c7ba52ee7b0",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=0deb415e-a725-4b88-ac60-8c7ba52ee7b0"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe3c9e77c03383e3e4a"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0deb415e-a725-4b88-ac60-8c7ba52ee7b0",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0deb415e-a725-4b88-ac60-8c7ba52ee7b0{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/0deb415e-a725-4b88-ac60-8c7ba52ee7b0/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/dc0b6206-2ba2-40da-a4bb-76a600806590/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" : "dc0b6206-2ba2-40da-a4bb-76a600806590",
  "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-03-12T21:08:51.411Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:08:51.440Z",
  "deliveryId" : "dc0b6206-2ba2-40da-a4bb-76a600806590",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=dc0b6206-2ba2-40da-a4bb-76a600806590"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881fe3c9e77c03383e3e43"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=dc0b6206-2ba2-40da-a4bb-76a600806590",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=dc0b6206-2ba2-40da-a4bb-76a600806590{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dc0b6206-2ba2-40da-a4bb-76a600806590/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/3e29756f-3182-4539-aa99-6318ee0a7402/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" : "3e29756f-3182-4539-aa99-6318ee0a7402"
  },
  "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/3e29756f-3182-4539-aa99-6318ee0a7402"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3e29756f-3182-4539-aa99-6318ee0a7402{&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/3fbe35dc-7e55-4a3f-8aec-d713dae3415a/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" : "3fbe35dc-7e55-4a3f-8aec-d713dae3415a",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3fbe35dc-7e55-4a3f-8aec-d713dae3415a"
        }
      }
    }, {
      "id" : "267e3ca1-968a-4dea-8ee8-c141e9416758",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/267e3ca1-968a-4dea-8ee8-c141e9416758"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3fbe35dc-7e55-4a3f-8aec-d713dae3415a/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3fbe35dc-7e55-4a3f-8aec-d713dae3415a/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/3fbe35dc-7e55-4a3f-8aec-d713dae3415a/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=06e9f01f-ce43-425a-baa3-171317117b55 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "06e9f01f-ce43-425a-baa3-171317117b55"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2019-03-12T21:10:13.768Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06e9f01f-ce43-425a-baa3-171317117b55"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=06e9f01f-ce43-425a-baa3-171317117b55{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=06e9f01f-ce43-425a-baa3-171317117b55&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=06e9f01f-ce43-425a-baa3-171317117b55&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=06e9f01f-ce43-425a-baa3-171317117b55&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/5c881ff7c9e77c03383e415c/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" : "5c881ff7c9e77c03383e415c",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff7c9e77c03383e415b"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff7c9e77c03383e415b/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c881ff7c9e77c03383e415b/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/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/5c881ff7c9e77c03383e415c/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5c881ff7c9e77c03383e415c/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/5c881ff7c9e77c03383e41a9/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

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

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

Administration

Listing Administrative Operations

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

The following operations are available based on your permissions

Table 5. Operations
Operation rel

Manage Access

"access"

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Managing Access

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

Auth rules

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

Example request

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

Example response

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

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

Listing operations for a resource

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

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

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

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/hubs/5c882041c9e77c03383e4e16 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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/5c882041c9e77c03383e4e16"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882041c9e77c03383e4e16/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882041c9e77c03383e4e16/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/5c882041c9e77c03383e4e15 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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/5c882041c9e77c03383e4e15"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4e15/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4e15/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/5c882040c9e77c03383e4d7f/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/5c882040c9e77c03383e4d7f/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4d7f/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/5c882041c9e77c03383e4d81/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/5c882041c9e77c03383e4d81/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/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/5c882041c9e77c03383e4d81/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5c882041c9e77c03383e4d81/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/5c882040c9e77c03383e4cee/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/5c882040c9e77c03383e4cee/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5c882040c9e77c03383e4cee/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/5c882041c9e77c03383e4dca/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/5c882041c9e77c03383e4dcb/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/5c88203fc9e77c03383e4c0c/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/5c88203fc9e77c03383e4c0c/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/5c88203fc9e77c03383e4c0c/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c0c"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c0c/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c0c/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c0c/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c0c/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/5c88203fc9e77c03383e4c09/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/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/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/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/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/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c09/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/5c88203fc9e77c03383e4c5b/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/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/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/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/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/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c5b/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/5c88203fc9e77c03383e4c11/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/5c88203fc9e77c03383e4c11/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c11"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c11/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c11/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c11/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c88203fc9e77c03383e4c11/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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, 12 Mar 2019 21:10:26 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 729

{
  "id" : "5c882042c9e77c03383e4f40",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2019-03-12T21:10:26.227Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2019-03-12T21:10:26.227Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5c882042c9e77c03383e4f40"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5c882042c9e77c03383e4f40"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5c882042c9e77c03383e4f3f"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5c882042c9e77c03383e4f40"
    }
  }
}

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

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

Required ACLs:
  • Hub - READ

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