Expand all

Integrating with the API

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

Overview

Root

"Root" is the root endpoint of the service

Getting root

Auth rules

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

Example request

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

Example response

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

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

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

Information

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

Supported Localization Settings

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

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Hubs

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

Creating a new Hub

Auth rules

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

Example request

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

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

Example response

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

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

{
  "_embedded" : {
    "hubs" : [ {
      "id" : "5e4d7a5946e0fb036387c2a2",
      "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" : "2020-02-19T18:11:37.788Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:37.788Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-types{?page,size,sort,status}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-type-schemas{?page,size,sort,status}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/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/5e4d7a5946e0fb036387c2a2/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a2/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7a5946e0fb036387c2a4",
      "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" : "2020-02-19T18:11:37.844Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:37.844Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-types{?page,size,sort,status}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-type-schemas{?page,size,sort,status}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/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/5e4d7a5946e0fb036387c2a4/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a4/workflow-states{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7a5946e0fb036387c2a6",
      "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" : "2020-02-19T18:11:37.899Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:37.899Z",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6"
        },
        "snapshots" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/snapshots{?page,size,sort,types}",
          "templated" : true
        },
        "create-snapshot" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/snapshots"
        },
        "events" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/events{?page,size,sort}",
          "templated" : true
        },
        "create-event" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/events"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6"
        },
        "update-settings" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/settings"
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/share"
        },
        "content-repositories" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-repositories{?page,size,sort}",
          "templated" : true
        },
        "create-content-repository" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-repositories"
        },
        "register-content-type" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-types"
        },
        "create-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-type-schemas"
        },
        "content-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-types{?page,size,sort,status}",
          "templated" : true
        },
        "list-content-type-schemas" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-type-schemas{?page,size,sort,status}",
          "templated" : true
        },
        "resolve-content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-type-schemas/resolve"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/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/5e4d7a5946e0fb036387c2a6/workflow-states"
        },
        "workflow-states" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5946e0fb036387c2a6/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/5e4d7a7646e0fb036387dbd0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "5e4d7a7646e0fb036387dbd0",
  "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" : "2020-02-19T18:12:06.091Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:06.091Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "extensions" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/extensions{?page,size,sort}",
      "templated" : true
    },
    "extensions-lite" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/extensions?show-full=false{&page,size,sort}",
      "templated" : true
    },
    "extension-by-name" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/extensions/{name}",
      "templated" : true
    },
    "create-extension" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/extensions"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-types{?page,size,sort,status}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-type-schemas{?page,size,sort,status}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/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/5e4d7a7646e0fb036387dbd0/webhooks{?page,size,sort}",
      "templated" : true
    },
    "create-webhook" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/webhooks"
    },
    "integrations" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/integrations{?page,size,sort}",
      "templated" : true
    },
    "create-workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7646e0fb036387dbd0/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/5e4d7a5a46e0fb036387c352 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 101

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

Example response

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

{
  "id" : "5e4d7a5a46e0fb036387c352",
  "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" : "2020-02-19T18:11:38.537Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:38.615Z",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352"
    },
    "snapshots" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/snapshots{?page,size,sort,types}",
      "templated" : true
    },
    "create-snapshot" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/snapshots"
    },
    "events" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/events{?page,size,sort}",
      "templated" : true
    },
    "create-event" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/events"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352"
    },
    "update-settings" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/settings"
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/share"
    },
    "content-repositories" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-repositories{?page,size,sort}",
      "templated" : true
    },
    "create-content-repository" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-repositories"
    },
    "register-content-type" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-types"
    },
    "create-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-type-schemas"
    },
    "content-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-types{?page,size,sort,status}",
      "templated" : true
    },
    "list-content-type-schemas" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-type-schemas{?page,size,sort,status}",
      "templated" : true
    },
    "resolve-content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-type-schemas/resolve"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/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/5e4d7a5a46e0fb036387c352/workflow-states"
    },
    "workflow-states" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5a46e0fb036387c352/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/5e4d7a7646e0fb036387dc26/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/5e4d7a7646e0fb036387dc26

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

Sharing a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

  • Hub - SHARE

Example request

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

{
  "user" : "alice",
  "additionalPermissions" : [ "READ", "EDIT", "DELETE" ]
}

Example response

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

Localization

See Localization for info on how to setup your Hub for Content Item level localization.

Content Types

Register a Content Type with a Hub

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

{
  "id" : "5e4d7a5d46e0fb036387c56e",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "status" : "ACTIVE",
  "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/5e4d7a5d46e0fb036387c56e"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5d46e0fb036387c56e"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5d46e0fb036387c56e/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5d46e0fb036387c56e/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5d46e0fb036387c56e"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5d46e0fb036387c56e/archive"
    }
  }
}

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

{
  "contentTypeId" : "5e4d7ab346e0fb036387ea75"
}

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5e4d7ab346e0fb036387ea1c",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab346e0fb036387ea18"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab346e0fb036387ea18/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab346e0fb036387ea18/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/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/5e4d7ab346e0fb036387ea1c/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab346e0fb036387ea1c/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/5e4d7a5b46e0fb036387c45a/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: 5372

{
  "_embedded" : {
    "content-types" : [ {
      "id" : "5e4d7a5c46e0fb036387c45d",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "status" : "ACTIVE",
      "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/5e4d7a5c46e0fb036387c45d"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45d"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45d/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45d/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45d"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45d/archive"
        }
      }
    }, {
      "id" : "5e4d7a5c46e0fb036387c461",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/schema_schema/cms-schema-v1.json",
      "status" : "ACTIVE",
      "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/5e4d7a5c46e0fb036387c461"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c461"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c461/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c461/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c461"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c461/archive"
        }
      }
    }, {
      "id" : "5e4d7a5c46e0fb036387c45f",
      "contentTypeUri" : "http://deliver.bigcontent.io/schema/schema_schema/draft-04.json",
      "status" : "ACTIVE",
      "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/5e4d7a5c46e0fb036387c45f"
        },
        "content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45f"
        },
        "effective-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45f/effective-content-type"
        },
        "content-type-schema" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45f/schema"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45f"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5c46e0fb036387c45f/archive"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5b46e0fb036387c45a/content-types?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5b46e0fb036387c45a/content-types?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5b46e0fb036387c45a/content-types?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a5b46e0fb036387c45a/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/5e4d7a5b46e0fb036387c404 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: 1390

{
  "id" : "5e4d7a5b46e0fb036387c404",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "status" : "ACTIVE",
  "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/5e4d7a5b46e0fb036387c404"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c404"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c404/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c404/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c404"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c404/archive"
    }
  }
}

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

{
  "id" : "5e4d7a5b46e0fb036387c3ab",
  "contentTypeUri" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
  "status" : "ACTIVE",
  "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/5e4d7a5b46e0fb036387c3ab"
    },
    "content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c3ab"
    },
    "effective-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c3ab/effective-content-type"
    },
    "content-type-schema" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c3ab/schema"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c3ab"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-types/5e4d7a5b46e0fb036387c3ab/archive"
    }
  }
}

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/5e4d7a5c46e0fb036387c515/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" : "5e4d7a5c46e0fb036387c512",
  "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/5e4d7a5c46e0fb036387c515/schema"
    }
  }
}

Update a Content Type Schema

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/content-types/5e4d7a5c46e0fb036387c4ba/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" : "5e4d7a5c46e0fb036387c4b7",
  "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/5e4d7a5c46e0fb036387c4ba/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/5e4d7a6446e0fb036387cac5/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/5e4d7a6446e0fb036387cac6
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3144

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

{
  "id" : "5e4d7a6346e0fb036387c9c1",
  "name" : "inspiration",
  "label" : "updated inspiration label",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a6346e0fb036387c9c0"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a6346e0fb036387c9c0/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a6346e0fb036387c9c0/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/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/5e4d7a6346e0fb036387c9c1/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c9c1/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/5e4d7ab246e0fb036387e9bd/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/5e4d7ab246e0fb036387e9c2/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/5e4d7ab246e0fb036387e9b8/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" : "5e4d7ab246e0fb036387e9ba",
      "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/5e4d7ab246e0fb036387e9ba"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8"
        },
        "create-content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/content-items"
        },
        "search-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8/content-items/find{?page,projection,query,size,sort}",
          "templated" : true
        },
        "facet-content-items" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8/content-items/facet{?page,projection,query,size,sort}",
          "templated" : true
        },
        "content-items" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/content-items{?folderId,page,projection,size,sort,status}",
          "templated" : true
        },
        "share" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/share"
        },
        "assign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/content-types"
        },
        "unassign-content-type" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/content-types/{id}",
          "templated" : true
        },
        "folders" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/folders{?page,size,sort}",
          "templated" : true
        },
        "create-folder" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/folders"
        },
        "features" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/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/5e4d7ab246e0fb036387e9ba/item-locales"
        },
        "join-localization-group" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/localization-group"
        },
        "localization-group-locales" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab246e0fb036387e9ba/localization-group/locales"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8/content-repositories/search/findByFeaturesContaining?feature=slots&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab246e0fb036387e9b8/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/5e4d7a6446e0fb036387ca6f/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/5e4d7a5f46e0fb036387c6d7/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" : "5e4d7a5f46e0fb036387c6db",
  "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: Wed, 19 Feb 2020 18:11:43 GMT
Location: https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4058

{
  "id" : "49e984e0-ea57-49df-8752-167a9a39c650",
  "folderId" : "5e4d7a5f46e0fb036387c6db",
  "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" : "2020-02-19T18:11:43.853Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:43.853Z",
  "deliveryId" : "49e984e0-ea57-49df-8752-167a9a39c650",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=49e984e0-ea57-49df-8752-167a9a39c650"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a5f46e0fb036387c6d7"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=49e984e0-ea57-49df-8752-167a9a39c650",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5e4d7a5f46e0fb036387c6db"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=49e984e0-ea57-49df-8752-167a9a39c650{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/49e984e0-ea57-49df-8752-167a9a39c650/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/01caa525-4af9-4361-b55c-8e855288d081 HTTP/1.1
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "id" : "01caa525-4af9-4361-b55c-8e855288d081",
  "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" : "2020-02-19T18:11:43.260Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:43.260Z",
  "deliveryId" : "01caa525-4af9-4361-b55c-8e855288d081",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=01caa525-4af9-4361-b55c-8e855288d081"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a5e46e0fb036387c67c"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=01caa525-4af9-4361-b55c-8e855288d081",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=01caa525-4af9-4361-b55c-8e855288d081{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/01caa525-4af9-4361-b55c-8e855288d081/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/ece721fe-75a4-4c2c-a63d-c68cbaccf92e 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" : "5e4d7a6046e0fb036387c738"
}

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:11:44 GMT
Location: https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4065

{
  "id" : "ece721fe-75a4-4c2c-a63d-c68cbaccf92e",
  "folderId" : "5e4d7a6046e0fb036387c738",
  "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" : "2020-02-19T18:11:44.353Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:44.412Z",
  "deliveryId" : "ece721fe-75a4-4c2c-a63d-c68cbaccf92e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ece721fe-75a4-4c2c-a63d-c68cbaccf92e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c734"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ece721fe-75a4-4c2c-a63d-c68cbaccf92e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5e4d7a6046e0fb036387c738"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ece721fe-75a4-4c2c-a63d-c68cbaccf92e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ece721fe-75a4-4c2c-a63d-c68cbaccf92e/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/5e4d7a9946e0fb036387e35e/content-items?sourceContentItemId=a4641067-4e64-4bd4-9d6b-b28838586d00 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 67

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:12:41 GMT
Location: https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3894

{
  "id" : "75142300-c182-4b4d-bcfd-4e84ed0068b4",
  "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" : "2020-02-19T18:12:41.409Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:41.409Z",
  "deliveryId" : "75142300-c182-4b4d-bcfd-4e84ed0068b4",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=75142300-c182-4b4d-bcfd-4e84ed0068b4"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9946e0fb036387e35e"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=75142300-c182-4b4d-bcfd-4e84ed0068b4",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=75142300-c182-4b4d-bcfd-4e84ed0068b4{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/75142300-c182-4b4d-bcfd-4e84ed0068b4/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/5e4d7a9946e0fb036387e366/content-items?sourceContentItemId=b8a6c54a-f073-4e08-9241-a2b117ecaad2 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" : "5e4d7a9946e0fb036387e36c"
}

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:12:41 GMT
Location: https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 4027

{
  "id" : "96f5651b-1b26-4360-a365-61e282b7cfdf",
  "folderId" : "5e4d7a9946e0fb036387e36c",
  "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" : "2020-02-19T18:12:41.655Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:41.655Z",
  "deliveryId" : "96f5651b-1b26-4360-a365-61e282b7cfdf",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=96f5651b-1b26-4360-a365-61e282b7cfdf"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9946e0fb036387e366"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=96f5651b-1b26-4360-a365-61e282b7cfdf",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/archive"
    },
    "folder" : {
      "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9946e0fb036387e36c"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=96f5651b-1b26-4360-a365-61e282b7cfdf{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/96f5651b-1b26-4360-a365-61e282b7cfdf/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/9a201370-8ac3-4e96-98a8-6fe804f270ff/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" : "9a201370-8ac3-4e96-98a8-6fe804f270ff",
  "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" : "2020-02-19T18:12:44.894Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:44.916Z",
  "deliveryId" : "9a201370-8ac3-4e96-98a8-6fe804f270ff",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9a201370-8ac3-4e96-98a8-6fe804f270ff"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9c46e0fb036387e56a"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9a201370-8ac3-4e96-98a8-6fe804f270ff",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9a201370-8ac3-4e96-98a8-6fe804f270ff{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9a201370-8ac3-4e96-98a8-6fe804f270ff/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/eab8cc93-91a0-4976-ba8d-1e59dda9418e/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" : "eab8cc93-91a0-4976-ba8d-1e59dda9418e",
  "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" : "eab8cc93-91a0-4976-ba8d-1e59dda9418e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=eab8cc93-91a0-4976-ba8d-1e59dda9418e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aaf46e0fb036387e7e6"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=eab8cc93-91a0-4976-ba8d-1e59dda9418e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=eab8cc93-91a0-4976-ba8d-1e59dda9418e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/eab8cc93-91a0-4976-ba8d-1e59dda9418e/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" : "5e4d7a6146e0fb036387c84f",
  "id" : "528bc6cc-3ec2-4989-9ed2-8df8156ed94e"
}, {
  "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" : "5e4d7a6146e0fb036387c84f",
  "id" : "358d9c37-9be5-4b96-ac35-b36910055f52"
} ]

Example response

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

{
  "results" : [ {
    "id" : "528bc6cc-3ec2-4989-9ed2-8df8156ed94e",
    "status" : 200,
    "code" : "SUCCESS",
    "level" : "INFO",
    "message" : null
  }, {
    "id" : "358d9c37-9be5-4b96-ac35-b36910055f52",
    "status" : 200,
    "code" : "SUCCESS",
    "level" : "INFO",
    "message" : null
  } ]
}

Listing Content Items

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/content-repositories/5e4d7a6046e0fb036387c791/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" : "747f4c1b-fd40-4762-a7a6-8f42564bd4a7",
      "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" : "2020-02-19T18:11:44.893Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:44.893Z",
      "deliveryId" : "747f4c1b-fd40-4762-a7a6-8f42564bd4a7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=747f4c1b-fd40-4762-a7a6-8f42564bd4a7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=747f4c1b-fd40-4762-a7a6-8f42564bd4a7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=747f4c1b-fd40-4762-a7a6-8f42564bd4a7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/747f4c1b-fd40-4762-a7a6-8f42564bd4a7/workflow"
        }
      }
    }, {
      "id" : "7ed75ed7-a858-41aa-8e2e-2f2ef100de99",
      "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" : "2020-02-19T18:11:44.843Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:44.843Z",
      "deliveryId" : "7ed75ed7-a858-41aa-8e2e-2f2ef100de99",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7ed75ed7-a858-41aa-8e2e-2f2ef100de99"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7ed75ed7-a858-41aa-8e2e-2f2ef100de99",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7ed75ed7-a858-41aa-8e2e-2f2ef100de99{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7ed75ed7-a858-41aa-8e2e-2f2ef100de99/workflow"
        }
      }
    }, {
      "id" : "07b39f97-028c-49fe-adf9-adf6d2f62140",
      "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" : "2020-02-19T18:11:44.810Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:44.810Z",
      "deliveryId" : "07b39f97-028c-49fe-adf9-adf6d2f62140",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=07b39f97-028c-49fe-adf9-adf6d2f62140"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=07b39f97-028c-49fe-adf9-adf6d2f62140",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=07b39f97-028c-49fe-adf9-adf6d2f62140{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/07b39f97-028c-49fe-adf9-adf6d2f62140/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791/content-items?page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6046e0fb036387c791/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/5e4d7ab046e0fb036387e843/content-items?projection=basic HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "_embedded" : {
    "content-items" : [ {
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "label" : "Banner Ad Homepage",
      "createdBy" : "user",
      "createdDate" : "2018-05-04T03:02:01.000Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2018-05-04T03:02:01.000Z",
      "deliveryId" : "fa895fc9-ab64-42f2-8690-f78a053dd48b",
      "folderId" : null,
      "version" : 1,
      "locale" : "en",
      "status" : "ACTIVE",
      "id" : "fa895fc9-ab64-42f2-8690-f78a053dd48b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=fa895fc9-ab64-42f2-8690-f78a053dd48b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab046e0fb036387e843"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fa895fc9-ab64-42f2-8690-f78a053dd48b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fa895fc9-ab64-42f2-8690-f78a053dd48b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fa895fc9-ab64-42f2-8690-f78a053dd48b/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab046e0fb036387e843/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab046e0fb036387e843/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab046e0fb036387e843/content-items?projection=basic&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab046e0fb036387e843/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/5e4d7a6146e0fb036387c7ee/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" : "58db4032-0539-4ca7-931b-5b6dc98b8c46",
      "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" : "2020-02-19T18:11:45.359Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:45.359Z",
      "deliveryId" : "58db4032-0539-4ca7-931b-5b6dc98b8c46",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=58db4032-0539-4ca7-931b-5b6dc98b8c46"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=58db4032-0539-4ca7-931b-5b6dc98b8c46",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=58db4032-0539-4ca7-931b-5b6dc98b8c46{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/58db4032-0539-4ca7-931b-5b6dc98b8c46/workflow"
        }
      }
    }, {
      "id" : "dd368dc3-695b-426e-bc3a-e09c923e432b",
      "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" : "2020-02-19T18:11:45.395Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:45.395Z",
      "deliveryId" : "dd368dc3-695b-426e-bc3a-e09c923e432b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=dd368dc3-695b-426e-bc3a-e09c923e432b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=dd368dc3-695b-426e-bc3a-e09c923e432b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=dd368dc3-695b-426e-bc3a-e09c923e432b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dd368dc3-695b-426e-bc3a-e09c923e432b/workflow"
        }
      }
    }, {
      "id" : "ef51ae58-15b2-4e63-8d03-99fd8edcafd2",
      "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" : "2020-02-19T18:11:45.436Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:45.436Z",
      "deliveryId" : "ef51ae58-15b2-4e63-8d03-99fd8edcafd2",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ef51ae58-15b2-4e63-8d03-99fd8edcafd2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ef51ae58-15b2-4e63-8d03-99fd8edcafd2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ef51ae58-15b2-4e63-8d03-99fd8edcafd2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef51ae58-15b2-4e63-8d03-99fd8edcafd2/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee/content-items?page=0&size=20&sort=label,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee/content-items?page=0&size=20&sort=label,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee/content-items?page=0&size=20&sort=label,asc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6146e0fb036387c7ee/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/5e4d7a9a46e0fb036387e42d/content-items?folderId=5e4d7a9a46e0fb036387e431 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "9e8b017f-0dc2-4b51-9964-8520199496b3",
      "folderId" : "5e4d7a9a46e0fb036387e431",
      "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" : "2020-02-19T18:12:42.728Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:42.728Z",
      "deliveryId" : "9e8b017f-0dc2-4b51-9964-8520199496b3",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9e8b017f-0dc2-4b51-9964-8520199496b3"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e42d"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9e8b017f-0dc2-4b51-9964-8520199496b3",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e431"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9e8b017f-0dc2-4b51-9964-8520199496b3{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9e8b017f-0dc2-4b51-9964-8520199496b3/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e42d/content-items?folderId=5e4d7a9a46e0fb036387e431&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e42d/content-items?folderId=5e4d7a9a46e0fb036387e431&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e42d/content-items?folderId=5e4d7a9a46e0fb036387e431&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e42d/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/5e4d7a9a46e0fb036387e420/content-items?folderId=5e4d7a9a46e0fb036387e424,5e4d7a9a46e0fb036387e425 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b",
      "folderId" : "5e4d7a9a46e0fb036387e425",
      "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" : "2020-02-19T18:12:42.478Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:42.478Z",
      "deliveryId" : "f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e425"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f48ec61f-2a71-4b47-81ab-b5cb0bc58e4b/workflow"
        }
      }
    }, {
      "id" : "06517283-a0c9-4aad-9e04-a20749040239",
      "folderId" : "5e4d7a9a46e0fb036387e425",
      "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" : "2020-02-19T18:12:42.455Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:42.455Z",
      "deliveryId" : "06517283-a0c9-4aad-9e04-a20749040239",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=06517283-a0c9-4aad-9e04-a20749040239"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=06517283-a0c9-4aad-9e04-a20749040239",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e425"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=06517283-a0c9-4aad-9e04-a20749040239{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/06517283-a0c9-4aad-9e04-a20749040239/workflow"
        }
      }
    }, {
      "id" : "b55a6b05-974b-4a14-b7ee-d17b86a7e218",
      "folderId" : "5e4d7a9a46e0fb036387e425",
      "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" : "2020-02-19T18:12:42.433Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:42.433Z",
      "deliveryId" : "b55a6b05-974b-4a14-b7ee-d17b86a7e218",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=b55a6b05-974b-4a14-b7ee-d17b86a7e218"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=b55a6b05-974b-4a14-b7ee-d17b86a7e218",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e425"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=b55a6b05-974b-4a14-b7ee-d17b86a7e218{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b55a6b05-974b-4a14-b7ee-d17b86a7e218/workflow"
        }
      }
    }, {
      "id" : "d72ecd3c-58c2-49c9-86e1-150649e7b121",
      "folderId" : "5e4d7a9a46e0fb036387e424",
      "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" : "2020-02-19T18:12:42.411Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:42.411Z",
      "deliveryId" : "d72ecd3c-58c2-49c9-86e1-150649e7b121",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d72ecd3c-58c2-49c9-86e1-150649e7b121"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d72ecd3c-58c2-49c9-86e1-150649e7b121",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e424"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d72ecd3c-58c2-49c9-86e1-150649e7b121{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d72ecd3c-58c2-49c9-86e1-150649e7b121/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420/content-items?folderId=5e4d7a9a46e0fb036387e424,5e4d7a9a46e0fb036387e425&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420/content-items?folderId=5e4d7a9a46e0fb036387e424,5e4d7a9a46e0fb036387e425&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420/content-items?folderId=5e4d7a9a46e0fb036387e424,5e4d7a9a46e0fb036387e425&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e420/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/5e4d7a9a46e0fb036387e43a/content-items?folderId=5e4d7a9a46e0fb036387e43e&folderId=5e4d7a9a46e0fb036387e43f HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "d5f981a9-f8c2-449b-b1f0-b67719f89169",
      "folderId" : "5e4d7a9a46e0fb036387e43f",
      "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" : "2020-02-19T18:12:43.072Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.072Z",
      "deliveryId" : "d5f981a9-f8c2-449b-b1f0-b67719f89169",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=d5f981a9-f8c2-449b-b1f0-b67719f89169"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=d5f981a9-f8c2-449b-b1f0-b67719f89169",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e43f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=d5f981a9-f8c2-449b-b1f0-b67719f89169{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/d5f981a9-f8c2-449b-b1f0-b67719f89169/workflow"
        }
      }
    }, {
      "id" : "2c236ba1-3db5-4723-a3b8-3f6ea8156620",
      "folderId" : "5e4d7a9a46e0fb036387e43f",
      "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" : "2020-02-19T18:12:43.049Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.049Z",
      "deliveryId" : "2c236ba1-3db5-4723-a3b8-3f6ea8156620",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2c236ba1-3db5-4723-a3b8-3f6ea8156620"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2c236ba1-3db5-4723-a3b8-3f6ea8156620",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e43f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2c236ba1-3db5-4723-a3b8-3f6ea8156620{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2c236ba1-3db5-4723-a3b8-3f6ea8156620/workflow"
        }
      }
    }, {
      "id" : "3c7a2ebd-1982-4a75-8834-006f6bc62712",
      "folderId" : "5e4d7a9a46e0fb036387e43f",
      "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" : "2020-02-19T18:12:43.027Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.027Z",
      "deliveryId" : "3c7a2ebd-1982-4a75-8834-006f6bc62712",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=3c7a2ebd-1982-4a75-8834-006f6bc62712"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3c7a2ebd-1982-4a75-8834-006f6bc62712",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e43f"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3c7a2ebd-1982-4a75-8834-006f6bc62712{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3c7a2ebd-1982-4a75-8834-006f6bc62712/workflow"
        }
      }
    }, {
      "id" : "66f5bd4f-3bf3-4157-840a-549764c1a0cf",
      "folderId" : "5e4d7a9a46e0fb036387e43e",
      "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" : "2020-02-19T18:12:43.004Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.004Z",
      "deliveryId" : "66f5bd4f-3bf3-4157-840a-549764c1a0cf",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=66f5bd4f-3bf3-4157-840a-549764c1a0cf"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=66f5bd4f-3bf3-4157-840a-549764c1a0cf",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9a46e0fb036387e43e"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=66f5bd4f-3bf3-4157-840a-549764c1a0cf{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/66f5bd4f-3bf3-4157-840a-549764c1a0cf/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a/content-items?folderId=5e4d7a9a46e0fb036387e43e&folderId=5e4d7a9a46e0fb036387e43f&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a/content-items?folderId=5e4d7a9a46e0fb036387e43e&folderId=5e4d7a9a46e0fb036387e43f&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a/content-items?folderId=5e4d7a9a46e0fb036387e43e&folderId=5e4d7a9a46e0fb036387e43f&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9a46e0fb036387e43a/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/5e4d7a9b46e0fb036387e447/content-items?folderId=!5e4d7a9b46e0fb036387e44b HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "56acb53e-fee7-4ddb-944a-e7231d677201",
      "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" : "2020-02-19T18:12:43.441Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.441Z",
      "deliveryId" : "56acb53e-fee7-4ddb-944a-e7231d677201",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=56acb53e-fee7-4ddb-944a-e7231d677201"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=56acb53e-fee7-4ddb-944a-e7231d677201",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=56acb53e-fee7-4ddb-944a-e7231d677201{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/56acb53e-fee7-4ddb-944a-e7231d677201/workflow"
        }
      }
    }, {
      "id" : "286f203f-3029-4c64-93a3-638a966ea971",
      "folderId" : "5e4d7a9b46e0fb036387e44c",
      "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" : "2020-02-19T18:12:43.410Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.410Z",
      "deliveryId" : "286f203f-3029-4c64-93a3-638a966ea971",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=286f203f-3029-4c64-93a3-638a966ea971"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=286f203f-3029-4c64-93a3-638a966ea971",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9b46e0fb036387e44c"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=286f203f-3029-4c64-93a3-638a966ea971{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/286f203f-3029-4c64-93a3-638a966ea971/workflow"
        }
      }
    }, {
      "id" : "2fd415b6-cfac-4f48-9a49-df4795b3d654",
      "folderId" : "5e4d7a9b46e0fb036387e44c",
      "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" : "2020-02-19T18:12:43.378Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.378Z",
      "deliveryId" : "2fd415b6-cfac-4f48-9a49-df4795b3d654",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=2fd415b6-cfac-4f48-9a49-df4795b3d654"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=2fd415b6-cfac-4f48-9a49-df4795b3d654",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9b46e0fb036387e44c"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=2fd415b6-cfac-4f48-9a49-df4795b3d654{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/2fd415b6-cfac-4f48-9a49-df4795b3d654/workflow"
        }
      }
    }, {
      "id" : "f3da3f0b-405d-4281-98d1-1e67e11b44ed",
      "folderId" : "5e4d7a9b46e0fb036387e44c",
      "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" : "2020-02-19T18:12:43.346Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:43.346Z",
      "deliveryId" : "f3da3f0b-405d-4281-98d1-1e67e11b44ed",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=f3da3f0b-405d-4281-98d1-1e67e11b44ed"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f3da3f0b-405d-4281-98d1-1e67e11b44ed",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/archive"
        },
        "folder" : {
          "href" : "https://api.amplience.net/v2/content/folders/5e4d7a9b46e0fb036387e44c"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f3da3f0b-405d-4281-98d1-1e67e11b44ed{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f3da3f0b-405d-4281-98d1-1e67e11b44ed/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447/content-items?folderId=!5e4d7a9b46e0fb036387e44b&page=0&size=20&sort=createdDate,desc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447/content-items?folderId=!5e4d7a9b46e0fb036387e44b&page=0&size=20&sort=createdDate,desc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447/content-items?folderId=!5e4d7a9b46e0fb036387e44b&page=0&size=20&sort=createdDate,desc"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9b46e0fb036387e447/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/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/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" : "2020-02-19T18:13:05.419Z",
        "historyEventId" : "f31957fb-2da9-41fc-beb8-27b9aa7b5340"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "b953af19-3984-4771-86e7-a317ba346bf6",
        "createdDate" : "2020-02-09T18:13:05.429Z",
        "historyEventId" : "60cb987f-9ae9-4128-b02a-45c40ebbd14e"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "30a15f59-1424-40f4-bfdd-11d6a3336332",
        "createdDate" : "2020-02-08T18:13:05.429Z",
        "historyEventId" : "765d190c-d267-4dd3-b47f-400f842bf108"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "dd78a77a-e8ee-4a1c-baea-6878cb836f64",
        "createdDate" : "2020-02-07T18:13:05.429Z",
        "historyEventId" : "c98a60f8-e347-474e-bd61-0bb5e70377ae"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "5f91f408-1da6-4305-aa2c-1e0c64d3698a",
        "createdDate" : "2020-02-06T18:13:05.429Z",
        "historyEventId" : "a4fa5bb4-8fe8-4dfb-827d-b47f98c8548b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ffea3970-c828-495b-aed3-6e6f312a5f0c",
        "createdDate" : "2020-02-05T18:13:05.429Z",
        "historyEventId" : "b8a9da00-7f05-44da-9841-e31a0c66b99d"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.418Z",
      "version" : 10,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/10"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/10/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.381Z",
        "historyEventId" : "3d01de3d-cdff-488b-83dd-5cbd1cc849bc"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4d279ee6-a8b2-4191-88a1-35e15b1ea835",
        "createdDate" : "2020-02-08T18:13:05.429Z",
        "historyEventId" : "9b1331e3-5342-4bb6-95aa-edaac84edeae"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "d92ef47e-af48-4f7a-9eb8-a379c3e52b5e",
        "createdDate" : "2020-02-07T18:13:05.429Z",
        "historyEventId" : "152f27e6-f9b8-47fa-b5f4-3e2e3a9aa85b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ef8bce47-3732-42d7-8382-835e3d5d003c",
        "createdDate" : "2020-02-06T18:13:05.429Z",
        "historyEventId" : "04eba706-a34d-4e85-813b-7461fbeac39e"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "8e56de34-2c77-4775-892c-9e2687933d65",
        "createdDate" : "2020-02-05T18:13:05.429Z",
        "historyEventId" : "ff653e93-3995-4896-b986-262b7f011ea8"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c1bc1e91-a946-4fd6-8fc9-19d0428f4f3f",
        "createdDate" : "2020-02-04T18:13:05.429Z",
        "historyEventId" : "d31535d4-1900-4b57-b092-7f71c2d747ea"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.380Z",
      "version" : 9,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/9"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/9/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.336Z",
        "historyEventId" : "18969da9-5dbc-436f-88a2-ded1485bc3ad"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "cdca19f5-b762-4116-ad5b-340058298afe",
        "createdDate" : "2020-02-07T18:13:05.429Z",
        "historyEventId" : "3a7fe918-39a9-4afe-a505-33203d705581"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "0aaaf4d3-a759-4f43-818a-d655ab28865c",
        "createdDate" : "2020-02-06T18:13:05.429Z",
        "historyEventId" : "39ed4062-2334-495e-9895-79184755948b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c5bc85aa-4430-401e-8b8b-371161c3c671",
        "createdDate" : "2020-02-05T18:13:05.429Z",
        "historyEventId" : "1a906b07-550a-45e4-b4e7-117ffb00a3b6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "705700e2-61bf-44d1-85c0-0d7e8313dcc7",
        "createdDate" : "2020-02-04T18:13:05.429Z",
        "historyEventId" : "d61c5810-f074-42e6-b9f9-9064ef195f24"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "695ac4c9-765e-43e7-8745-3aec3e0c205a",
        "createdDate" : "2020-02-03T18:13:05.429Z",
        "historyEventId" : "357b2abd-01be-4533-9714-742ebff9ec0f"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.334Z",
      "version" : 8,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/8"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/8/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.280Z",
        "historyEventId" : "64ba5662-5767-415f-aa2f-ecd5593471b6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a8bdca18-f67f-4532-9c9a-97614ed50658",
        "createdDate" : "2020-02-06T18:13:05.429Z",
        "historyEventId" : "92ed1391-dae9-4690-b505-aba7d23fb736"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c9231b1e-8f9b-4ff7-838f-784d0f50e24c",
        "createdDate" : "2020-02-05T18:13:05.429Z",
        "historyEventId" : "e7d0fd52-9341-4afa-b3be-cbdebb07bc2a"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "ed664c39-807c-4632-8877-7d6f9ee5dff2",
        "createdDate" : "2020-02-04T18:13:05.429Z",
        "historyEventId" : "e9f95101-65de-4a14-b163-06c0856f8e23"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "de726471-6a75-4c7a-8003-97efe4e45179",
        "createdDate" : "2020-02-03T18:13:05.429Z",
        "historyEventId" : "71502f1d-785e-4cbb-b334-35a1fa608402"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "1f6bcc9c-f2ef-48b9-88e4-9e0440dbbc07",
        "createdDate" : "2020-02-02T18:13:05.429Z",
        "historyEventId" : "971c0122-14dd-4e3a-a8cd-9a755d8d8c12"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.278Z",
      "version" : 7,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/7"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/7/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.208Z",
        "historyEventId" : "a5dbd238-b995-4984-8741-e1ae8d5153d6"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "7a403fe7-5773-46b3-b20a-00bcc64ba781",
        "createdDate" : "2020-02-05T18:13:05.429Z",
        "historyEventId" : "587428db-82ec-4e73-8af6-43452c4403c7"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "939e810e-84b2-45bf-aa23-ed77be47b70f",
        "createdDate" : "2020-02-04T18:13:05.429Z",
        "historyEventId" : "0f9951ba-41a6-45fb-b5a4-8b5bdd05c16a"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "dacc2f68-4e52-4319-b744-f85a1c93630d",
        "createdDate" : "2020-02-03T18:13:05.429Z",
        "historyEventId" : "96cb8566-2290-44ce-85b8-d0dbac704988"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "540289ec-bd9b-4ac5-913a-fb5ea4da11d0",
        "createdDate" : "2020-02-02T18:13:05.429Z",
        "historyEventId" : "b7ebb603-9400-4b45-a031-6e0b23087a12"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "c8678ad5-7e40-466a-9ee5-78368bc169cf",
        "createdDate" : "2020-02-01T18:13:05.429Z",
        "historyEventId" : "12ccfa09-0d5d-41e4-b70e-209f2d6e692e"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.206Z",
      "version" : 6,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/6"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/6/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.157Z",
        "historyEventId" : "01a1502a-2789-4a78-a72f-5fd4011c0db5"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "c1da41f6-7575-4b32-8e94-6e90bc271aac",
        "createdDate" : "2020-02-04T18:13:05.429Z",
        "historyEventId" : "0328facc-390d-43e2-b518-6f0937ad7e85"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "78305ff2-b19f-4512-9fb8-b1ee65b05606",
        "createdDate" : "2020-02-03T18:13:05.429Z",
        "historyEventId" : "69ba2eee-ed94-4a26-8dc9-544ca398cc41"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "afe7c732-65f0-4890-8288-3cae4c906366",
        "createdDate" : "2020-02-02T18:13:05.429Z",
        "historyEventId" : "73129862-2d1c-4bf1-b904-1f062318b80e"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "0bb0069b-c1c5-4b54-bd94-4a860ffb2629",
        "createdDate" : "2020-02-01T18:13:05.429Z",
        "historyEventId" : "05cde632-4012-44b8-96e5-04d302cbc6a4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "a7a813e5-4ceb-4c27-b94d-153bf62d5cee",
        "createdDate" : "2020-01-31T18:13:05.429Z",
        "historyEventId" : "69880b1a-0d9d-4926-b9fa-6f2f7823aefa"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.156Z",
      "version" : 5,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/5"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/5/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.116Z",
        "historyEventId" : "3d971560-71cb-4cce-8006-ee6755656ea4"
      }, {
        "action" : {
          "code" : "UNTAGGED_FROM_EDITION",
          "data" : { }
        },
        "createdBy" : "153f6f86-4e7d-4f3d-a21f-8399ddffa7cd",
        "createdDate" : "2020-02-03T18:13:05.429Z",
        "historyEventId" : "026312e9-d641-48db-8f3e-1be3d89ab817"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "73134c98-0ae0-41d4-9d5d-5fd34beb859a",
        "createdDate" : "2020-02-02T18:13:05.429Z",
        "historyEventId" : "dfb04dd8-f157-4e43-b3b2-033832c6c1f1"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "240a200b-7727-4aa3-96c5-403aa5a5d896",
        "createdDate" : "2020-02-01T18:13:05.429Z",
        "historyEventId" : "c00bf8f2-e851-468c-98bb-d63999ae7233"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "6516976f-a00a-4258-a34d-526abaaa7296",
        "createdDate" : "2020-01-31T18:13:05.429Z",
        "historyEventId" : "760aaeb0-bcba-425c-bcfa-baa3b0973ce9"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.114Z",
      "version" : 4,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/4"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/4/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.072Z",
        "historyEventId" : "1bb0a440-2a50-464e-a964-5d5d14cedf63"
      }, {
        "action" : {
          "code" : "PUBLISH_COMPLETED",
          "data" : { }
        },
        "createdBy" : "c618012c-55ec-4a17-8407-90e452eaa774",
        "createdDate" : "2020-02-02T18:13:05.429Z",
        "historyEventId" : "08b9f0f0-836e-436e-b263-95b324a872a9"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "c70d40c9-ed56-4374-9cbf-c5c8527fc2a4",
        "createdDate" : "2020-02-01T18:13:05.429Z",
        "historyEventId" : "f49150ff-2fa4-445c-9ec5-1721b9d1ae90"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "0a9db358-ae53-4ad0-8026-171e09ff0f06",
        "createdDate" : "2020-01-31T18:13:05.429Z",
        "historyEventId" : "44815e03-3b54-448f-98e5-89f26837f02b"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.070Z",
      "version" : 3,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/3"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/3/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:05.026Z",
        "historyEventId" : "358675c8-488d-431b-a2de-323b404d2197"
      }, {
        "action" : {
          "code" : "TAGGED_TO_EDITION",
          "data" : { }
        },
        "createdBy" : "b33a3ece-55a4-4c65-9e83-fc878a9afc86",
        "createdDate" : "2020-02-01T18:13:05.429Z",
        "historyEventId" : "5c7daf59-d626-4569-a897-b2f89cabb1b4"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "2b9dcf3b-0a41-4e99-936a-98e8e0e57506",
        "createdDate" : "2020-01-31T18:13:05.429Z",
        "historyEventId" : "40117591-d65a-46ab-ba35-6e17e16b2586"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:05.025Z",
      "version" : 2,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/2/history{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "summary" : [ {
        "action" : {
          "code" : "CREATED",
          "data" : { }
        },
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:04.982Z",
        "historyEventId" : "2f23f0d9-38e0-4592-8bb5-0a60bd0eb46b"
      }, {
        "action" : {
          "code" : "UPDATED",
          "data" : { }
        },
        "createdBy" : "4b40f38b-c0da-4450-80a8-a2bc165243c7",
        "createdDate" : "2020-01-31T18:13:05.429Z",
        "historyEventId" : "184cea21-f6b3-4b1d-9366-6be3dfcdc4ab"
      } ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:04.980Z",
      "version" : 1,
      "_links" : {
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/versions/1/history{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b3ec3042-53a2-4cfd-ba33-e23c82a8bde5/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/b915351e-4935-4ab5-8d37-011d4c140913/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" : "1f913999-6c14-4abc-8e8c-7ace61b7021e",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-19T18:13:08.858Z",
      "createdBy" : "user",
      "action" : {
        "code" : "CREATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "c223d665-7074-423a-abd5-92f194824ce8",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-15T18:13:08.867Z",
      "createdBy" : "user 16",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "a2836110-59d0-443a-8470-758254f8a9e2",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-14T18:13:08.867Z",
      "createdBy" : "user 15",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "a7001f34-6f40-4ccb-88ed-479181384a40",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-13T18:13:08.867Z",
      "createdBy" : "user 14",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "9933727d-972e-477a-b56d-20abfd1f9732",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-12T18:13:08.867Z",
      "createdBy" : "user 13",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "7e6944e8-15fe-439d-940b-faf1e5a61971",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-11T18:13:08.867Z",
      "createdBy" : "user 12",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "9863c8ed-e16a-4763-88b2-054e7bce59a8",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-10T18:13:08.867Z",
      "createdBy" : "user 11",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "75f5ead4-4d54-4d88-9470-ffc1717aae27",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-09T18:13:08.867Z",
      "createdBy" : "user 10",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "20c3a8e3-19e5-4776-a4d3-d0deb14a49e3",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-08T18:13:08.867Z",
      "createdBy" : "user 9",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "b30ecf47-ffa9-44b6-a535-d8ee3655178f",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-07T18:13:08.867Z",
      "createdBy" : "user 8",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "37a809fa-289a-4465-8338-51e8f557fd18",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-06T18:13:08.867Z",
      "createdBy" : "user 7",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "5aa8be7b-3f9f-4ac0-bf13-342f098fe44d",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-05T18:13:08.867Z",
      "createdBy" : "user 6",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "2e2c8b90-29a3-4263-a03a-77ac2c86a74d",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-04T18:13:08.867Z",
      "createdBy" : "user 5",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    }, {
      "historyEventId" : "39376644-73fe-4a2e-80c7-d7eda8afa529",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-03T18:13:08.867Z",
      "createdBy" : "user 4",
      "action" : {
        "code" : "UNTAGGED_FROM_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "c1c24149-832a-4b43-b281-1a35e15a7e88",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-02T18:13:08.867Z",
      "createdBy" : "user 3",
      "action" : {
        "code" : "PUBLISH_COMPLETED",
        "data" : { }
      }
    }, {
      "historyEventId" : "b693b685-f3f6-44d6-a826-b3ca7668ff3a",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-02-01T18:13:08.867Z",
      "createdBy" : "user 2",
      "action" : {
        "code" : "TAGGED_TO_EDITION",
        "data" : { }
      }
    }, {
      "historyEventId" : "9574111f-b36d-469f-b5a9-216465817aa9",
      "contentItemId" : "b915351e-4935-4ab5-8d37-011d4c140913",
      "version" : 1,
      "createdDate" : "2020-01-31T18:13:08.867Z",
      "createdBy" : "user 1",
      "action" : {
        "code" : "UPDATED",
        "data" : { }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b915351e-4935-4ab5-8d37-011d4c140913/versions/1/history?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b915351e-4935-4ab5-8d37-011d4c140913/versions/1/history?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/b915351e-4935-4ab5-8d37-011d4c140913/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/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/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" : "dab1bf8b-49b4-4bf7-b163-e618cb764ed3",
      "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" : "2020-02-19T18:13:05.871Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:05.923Z",
      "deliveryId" : "dab1bf8b-49b4-4bf7-b163-e618cb764ed3",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions/2"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions/2/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab146e0fb036387e903"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=dab1bf8b-49b4-4bf7-b163-e618cb764ed3"
        }
      }
    }, {
      "id" : "dab1bf8b-49b4-4bf7-b163-e618cb764ed3",
      "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" : "2020-02-19T18:13:05.871Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:05.923Z",
      "deliveryId" : "dab1bf8b-49b4-4bf7-b163-e618cb764ed3",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/planned{?epoch,time}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions/1"
        },
        "content-item-version-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions/1/history{?page,size,sort}",
          "templated" : true
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3{?projection}",
          "templated" : true
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions{?page,size,sort}",
          "templated" : true
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab146e0fb036387e903"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=dab1bf8b-49b4-4bf7-b163-e618cb764ed3"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/versions?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/dab1bf8b-49b4-4bf7-b163-e618cb764ed3/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=5cb1426a-e37f-47fd-a866-4fac8b4f22fe 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" : "5cb1426a-e37f-47fd-a866-4fac8b4f22fe",
      "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" : "773001ea-b9b9-494e-b54c-6364e6ee56b1"
        } ]
      },
      "version" : 1,
      "label" : "nested-2",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:11:42.129Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:42.129Z",
      "deliveryId" : "5cb1426a-e37f-47fd-a866-4fac8b4f22fe",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5cb1426a-e37f-47fd-a866-4fac8b4f22fe"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a5d46e0fb036387c5c7"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=5cb1426a-e37f-47fd-a866-4fac8b4f22fe",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=5cb1426a-e37f-47fd-a866-4fac8b4f22fe{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe/workflow"
        }
      }
    }, {
      "id" : "773001ea-b9b9-494e-b54c-6364e6ee56b1",
      "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" : "85a36634-75aa-436b-9403-640155dc96c7"
        } ]
      },
      "version" : 1,
      "label" : "nested-1",
      "status" : "ACTIVE",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:11:42.086Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:42.086Z",
      "deliveryId" : "773001ea-b9b9-494e-b54c-6364e6ee56b1",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/publish"
        },
        "linked-content" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7{?projection}",
          "templated" : true
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=773001ea-b9b9-494e-b54c-6364e6ee56b1"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a5d46e0fb036387c5c7"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=773001ea-b9b9-494e-b54c-6364e6ee56b1",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=773001ea-b9b9-494e-b54c-6364e6ee56b1{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/773001ea-b9b9-494e-b54c-6364e6ee56b1/workflow"
        }
      }
    }, {
      "id" : "85a36634-75aa-436b-9403-640155dc96c7",
      "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" : "2020-02-19T18:11:41.949Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:11:41.949Z",
      "deliveryId" : "85a36634-75aa-436b-9403-640155dc96c7",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7{?projection}",
          "templated" : true
        },
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/publish"
        },
        "content-item-with-children" : {
          "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=85a36634-75aa-436b-9403-640155dc96c7"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a5d46e0fb036387c5c7"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=85a36634-75aa-436b-9403-640155dc96c7",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=85a36634-75aa-436b-9403-640155dc96c7{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/85a36634-75aa-436b-9403-640155dc96c7/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=5cb1426a-e37f-47fd-a866-4fac8b4f22fe"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/5cb1426a-e37f-47fd-a866-4fac8b4f22fe{?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/ded3d5f9-6321-4e55-ac09-454689edf903/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" : "ded3d5f9-6321-4e55-ac09-454689edf903",
  "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" : "2020-02-19T18:11:47.109Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:47.109Z",
  "deliveryId" : "ded3d5f9-6321-4e55-ac09-454689edf903",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903/versions/1"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903/versions/1/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/ded3d5f9-6321-4e55-ac09-454689edf903/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6246e0fb036387c908"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=ded3d5f9-6321-4e55-ac09-454689edf903"
    }
  }
}

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/022d447e-5fb4-42f8-9789-6357f2379173/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" : "022d447e-5fb4-42f8-9789-6357f2379173",
  "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" : "2020-02-19T18:11:46.469Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:46.624Z",
  "deliveryId" : "022d447e-5fb4-42f8-9789-6357f2379173",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173/versions/2"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173/versions/2/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/022d447e-5fb4-42f8-9789-6357f2379173/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6246e0fb036387c8aa"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=022d447e-5fb4-42f8-9789-6357f2379173"
    }
  }
}

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/feda51f0-8836-43fc-a251-fc75c24f3761/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" : "feda51f0-8836-43fc-a251-fc75c24f3761",
  "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" : "2020-02-19T18:11:47.525Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:11:47.639Z",
  "deliveryId" : "feda51f0-8836-43fc-a251-fc75c24f3761",
  "_links" : {
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761/planned{?epoch,time}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761/versions/3"
    },
    "content-item-version-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761/versions/3/history{?page,size,sort}",
      "templated" : true
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761{?projection}",
      "templated" : true
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/feda51f0-8836-43fc-a251-fc75c24f3761/versions{?page,size,sort}",
      "templated" : true
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a6346e0fb036387c964"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=feda51f0-8836-43fc-a251-fc75c24f3761"
    }
  }
}

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/16999774-6d62-413d-aeb3-b36bbb2bb8e3/restore HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 43

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

Example response

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

{
  "id" : "16999774-6d62-413d-aeb3-b36bbb2bb8e3",
  "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" : "2020-02-19T18:13:03.574Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:03.673Z",
  "deliveryId" : "16999774-6d62-413d-aeb3-b36bbb2bb8e3",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=16999774-6d62-413d-aeb3-b36bbb2bb8e3"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aaf46e0fb036387e787"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=16999774-6d62-413d-aeb3-b36bbb2bb8e3",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=16999774-6d62-413d-aeb3-b36bbb2bb8e3{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/16999774-6d62-413d-aeb3-b36bbb2bb8e3/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/5e4d7aa246e0fb036387e5c5/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" : "f11beda5-8755-4144-b16d-a4155517ce8c",
      "contentRepositoryId" : "5e4d7aa246e0fb036387e5c6",
      "folderId" : null,
      "deliveryId" : "f11beda5-8755-4144-b16d-a4155517ce8c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "uniondusk",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:12:52.094Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:52.094Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa246e0fb036387e5c6"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=f11beda5-8755-4144-b16d-a4155517ce8c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=f11beda5-8755-4144-b16d-a4155517ce8c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f11beda5-8755-4144-b16d-a4155517ce8c/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa246e0fb036387e5c5/content-items/find?query=uniondusk&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa246e0fb036387e5c5/content-items/find?query=uniondusk&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa246e0fb036387e5c5/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/5e4d7aa846e0fb036387e621/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: 756

{
  "fields" : [ {
    "facetAs" : "ENUM",
    "filter" : {
      "type" : "EQ",
      "values" : [ "NONE" ],
      "includeWithMissingField" : false
    },
    "field" : "publishingStatus"
  }, {
    "facetAs" : "ENUM",
    "filter" : {
      "type" : "EQ",
      "values" : [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ],
      "includeWithMissingField" : false
    },
    "field" : "schema"
  }, {
    "facetAs" : "DATE",
    "filter" : {
      "type" : "DATE",
      "values" : [ "-29:DAYS,NOW" ],
      "includeWithMissingField" : false
    },
    "name" : "-30 days",
    "range" : {
      "start" : "-29:DAYS",
      "end" : "NOW",
      "gap" : "30:DAYS"
    },
    "field" : "lastModifiedDate"
  } ],
  "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" : "44a272de-66ef-4bf0-85a7-72745de8e061",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "44a272de-66ef-4bf0-85a7-72745de8e061",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "4c9b6536-0138-4b71-8daf-4463b0a2d46a",
      "createdBy" : "user",
      "createdDate" : "2020-01-21T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-21T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=44a272de-66ef-4bf0-85a7-72745de8e061",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=44a272de-66ef-4bf0-85a7-72745de8e061{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/44a272de-66ef-4bf0-85a7-72745de8e061/workflow"
        }
      }
    }, {
      "id" : "eb03842d-02d9-4555-9456-d9f91b584814",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "eb03842d-02d9-4555-9456-d9f91b584814",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b03d5e9f-34e4-46bd-af46-2dd537525e26",
      "createdBy" : "user",
      "createdDate" : "2020-01-22T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-22T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=eb03842d-02d9-4555-9456-d9f91b584814",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=eb03842d-02d9-4555-9456-d9f91b584814{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/eb03842d-02d9-4555-9456-d9f91b584814/workflow"
        }
      }
    }, {
      "id" : "db5a8a1a-9f13-442c-bf03-355c0af27324",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "db5a8a1a-9f13-442c-bf03-355c0af27324",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "d66a9baa-e1f6-4ef3-a552-bef872a434b4",
      "createdBy" : "user",
      "createdDate" : "2020-01-23T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-23T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=db5a8a1a-9f13-442c-bf03-355c0af27324",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=db5a8a1a-9f13-442c-bf03-355c0af27324{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/db5a8a1a-9f13-442c-bf03-355c0af27324/workflow"
        }
      }
    }, {
      "id" : "e1434215-6008-4927-a282-7ea4c2cf926d",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "e1434215-6008-4927-a282-7ea4c2cf926d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "3978c05a-7593-4276-a136-9d2c72a34e1d",
      "createdBy" : "user",
      "createdDate" : "2020-01-24T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-24T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e1434215-6008-4927-a282-7ea4c2cf926d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e1434215-6008-4927-a282-7ea4c2cf926d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e1434215-6008-4927-a282-7ea4c2cf926d/workflow"
        }
      }
    }, {
      "id" : "3ec08a85-7c01-4ca5-b602-3227be44869d",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "3ec08a85-7c01-4ca5-b602-3227be44869d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "f163ea04-69e4-4cee-b139-4329b47d0805",
      "createdBy" : "user",
      "createdDate" : "2020-01-25T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-25T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=3ec08a85-7c01-4ca5-b602-3227be44869d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=3ec08a85-7c01-4ca5-b602-3227be44869d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/3ec08a85-7c01-4ca5-b602-3227be44869d/workflow"
        }
      }
    }, {
      "id" : "730407e7-94b5-47bd-854c-38f47a390e1b",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "730407e7-94b5-47bd-854c-38f47a390e1b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "dd1ac30c-1e00-461a-acda-94e1341d126b",
      "createdBy" : "user",
      "createdDate" : "2020-01-26T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-26T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=730407e7-94b5-47bd-854c-38f47a390e1b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=730407e7-94b5-47bd-854c-38f47a390e1b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/730407e7-94b5-47bd-854c-38f47a390e1b/workflow"
        }
      }
    }, {
      "id" : "900de2df-92c9-4936-a6c5-d84a2e16331e",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "900de2df-92c9-4936-a6c5-d84a2e16331e",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b3cb144b-4c45-4d9b-94e2-5c102fafe075",
      "createdBy" : "user",
      "createdDate" : "2020-01-27T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-27T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=900de2df-92c9-4936-a6c5-d84a2e16331e",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=900de2df-92c9-4936-a6c5-d84a2e16331e{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/900de2df-92c9-4936-a6c5-d84a2e16331e/workflow"
        }
      }
    }, {
      "id" : "ca875b71-7184-49af-a836-8ead42619b97",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "ca875b71-7184-49af-a836-8ead42619b97",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b7b33fcd-cf3a-4bd1-a118-1c8b147c1497",
      "createdBy" : "user",
      "createdDate" : "2020-01-28T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-28T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ca875b71-7184-49af-a836-8ead42619b97",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ca875b71-7184-49af-a836-8ead42619b97{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ca875b71-7184-49af-a836-8ead42619b97/workflow"
        }
      }
    }, {
      "id" : "94666352-f9c6-43f1-bcaa-c6b4520b470d",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "94666352-f9c6-43f1-bcaa-c6b4520b470d",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "349f85b2-e2ed-4ba6-81b6-faabab6426c7",
      "createdBy" : "user",
      "createdDate" : "2020-01-29T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-29T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=94666352-f9c6-43f1-bcaa-c6b4520b470d",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=94666352-f9c6-43f1-bcaa-c6b4520b470d{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/94666352-f9c6-43f1-bcaa-c6b4520b470d/workflow"
        }
      }
    }, {
      "id" : "9bece413-dc8f-4e04-9122-724e21cdc61c",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "9bece413-dc8f-4e04-9122-724e21cdc61c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "8411c3d5-d786-4eb9-bc2f-fbac4f4c073e",
      "createdBy" : "user",
      "createdDate" : "2020-01-30T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-30T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9bece413-dc8f-4e04-9122-724e21cdc61c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9bece413-dc8f-4e04-9122-724e21cdc61c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/9bece413-dc8f-4e04-9122-724e21cdc61c/workflow"
        }
      }
    }, {
      "id" : "fc57e3ce-a5c7-4108-bc6c-845c85e5dcee",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "fc57e3ce-a5c7-4108-bc6c-845c85e5dcee",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "f68ed495-96b1-40d8-bc03-5288ccb704aa",
      "createdBy" : "user",
      "createdDate" : "2020-01-31T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-01-31T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=fc57e3ce-a5c7-4108-bc6c-845c85e5dcee",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=fc57e3ce-a5c7-4108-bc6c-845c85e5dcee{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/fc57e3ce-a5c7-4108-bc6c-845c85e5dcee/workflow"
        }
      }
    }, {
      "id" : "e29cf5b2-a71f-4a85-9617-4cbcbda9b677",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "e29cf5b2-a71f-4a85-9617-4cbcbda9b677",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "e998c0df-4470-44e1-ac48-29c04c33deb6",
      "createdBy" : "user",
      "createdDate" : "2020-02-01T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-01T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=e29cf5b2-a71f-4a85-9617-4cbcbda9b677",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=e29cf5b2-a71f-4a85-9617-4cbcbda9b677{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e29cf5b2-a71f-4a85-9617-4cbcbda9b677/workflow"
        }
      }
    }, {
      "id" : "0636efe3-7c2c-4de8-9a7b-b7a510509852",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "0636efe3-7c2c-4de8-9a7b-b7a510509852",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "8b874ebc-eb46-4b87-b957-cc0d3e2891d3",
      "createdBy" : "user",
      "createdDate" : "2020-02-02T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-02T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0636efe3-7c2c-4de8-9a7b-b7a510509852",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0636efe3-7c2c-4de8-9a7b-b7a510509852{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0636efe3-7c2c-4de8-9a7b-b7a510509852/workflow"
        }
      }
    }, {
      "id" : "ef88fedf-d670-4f84-a082-83c71dc4574c",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "ef88fedf-d670-4f84-a082-83c71dc4574c",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "70361992-0c20-448b-bf99-bd1c8b5af5b9",
      "createdBy" : "user",
      "createdDate" : "2020-02-03T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-03T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=ef88fedf-d670-4f84-a082-83c71dc4574c",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=ef88fedf-d670-4f84-a082-83c71dc4574c{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/ef88fedf-d670-4f84-a082-83c71dc4574c/workflow"
        }
      }
    }, {
      "id" : "49fe1139-b17a-41fa-820d-ade5fe821dd2",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "49fe1139-b17a-41fa-820d-ade5fe821dd2",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "682e69ab-9087-43e3-87a2-af31a2516dc1",
      "createdBy" : "user",
      "createdDate" : "2020-02-04T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-04T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=49fe1139-b17a-41fa-820d-ade5fe821dd2",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=49fe1139-b17a-41fa-820d-ade5fe821dd2{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/49fe1139-b17a-41fa-820d-ade5fe821dd2/workflow"
        }
      }
    }, {
      "id" : "002e8c31-f846-4a9b-97dc-004431c17932",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "002e8c31-f846-4a9b-97dc-004431c17932",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "b091fece-feca-4025-b762-09ec4df88dd9",
      "createdBy" : "user",
      "createdDate" : "2020-02-05T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-05T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=002e8c31-f846-4a9b-97dc-004431c17932",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=002e8c31-f846-4a9b-97dc-004431c17932{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/002e8c31-f846-4a9b-97dc-004431c17932/workflow"
        }
      }
    }, {
      "id" : "0784abaf-eca3-4dc5-a40b-6665f7cb04fa",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "0784abaf-eca3-4dc5-a40b-6665f7cb04fa",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "db51ff48-cd03-40a6-a286-dedfb2caa607",
      "createdBy" : "user",
      "createdDate" : "2020-02-06T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-06T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=0784abaf-eca3-4dc5-a40b-6665f7cb04fa",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=0784abaf-eca3-4dc5-a40b-6665f7cb04fa{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/0784abaf-eca3-4dc5-a40b-6665f7cb04fa/workflow"
        }
      }
    }, {
      "id" : "51fae780-594f-4138-b551-02ce551f753b",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "51fae780-594f-4138-b551-02ce551f753b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "8d34cc93-539a-4ce7-ac72-d97815fff361",
      "createdBy" : "user",
      "createdDate" : "2020-02-07T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-07T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=51fae780-594f-4138-b551-02ce551f753b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=51fae780-594f-4138-b551-02ce551f753b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/51fae780-594f-4138-b551-02ce551f753b/workflow"
        }
      }
    }, {
      "id" : "62c879ec-cca9-40b5-8472-b62c6b2ddd93",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "62c879ec-cca9-40b5-8472-b62c6b2ddd93",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "c08ef63d-dbf4-42bf-8d31-aa403ebee983",
      "createdBy" : "user",
      "createdDate" : "2020-02-08T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-08T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=62c879ec-cca9-40b5-8472-b62c6b2ddd93",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=62c879ec-cca9-40b5-8472-b62c6b2ddd93{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/62c879ec-cca9-40b5-8472-b62c6b2ddd93/workflow"
        }
      }
    }, {
      "id" : "cfc48d75-5cd4-42eb-ab52-2777deea2e8b",
      "contentRepositoryId" : "5e4d7aa846e0fb036387e627",
      "folderId" : null,
      "deliveryId" : "cfc48d75-5cd4-42eb-ab52-2777deea2e8b",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "version" : 1,
      "status" : "ACTIVE",
      "label" : "6d3d6787-474c-48bc-83d7-c9713a8566b7",
      "createdBy" : "user",
      "createdDate" : "2020-02-09T18:12:55.845Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-09T18:12:55.845Z",
      "_links" : {
        "planned" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/planned{?epoch,time}",
          "templated" : true
        },
        "publish" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/publish"
        },
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b{?projection}",
          "templated" : true
        },
        "self" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b"
        },
        "restore-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/restore"
        },
        "content-repository" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aa846e0fb036387e627"
        },
        "content-item-version" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/versions{/version}",
          "templated" : true
        },
        "content-item-versions" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/versions{?page,size,sort}",
          "templated" : true
        },
        "content-item-history" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/history{?page,size,sort}",
          "templated" : true
        },
        "copy" : {
          "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=cfc48d75-5cd4-42eb-ab52-2777deea2e8b",
          "templated" : true
        },
        "unarchive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/unarchive"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/archive"
        },
        "set-locale" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/locale"
        },
        "create-localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/localize"
        },
        "localizations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/localizations{?page,size,sort}",
          "templated" : true
        },
        "localization-jobs" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=cfc48d75-5cd4-42eb-ab52-2777deea2e8b{&page,size,sort}",
          "templated" : true
        },
        "edition-slot-associations" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/edition-slot-associations"
        },
        "edit-workflow" : {
          "href" : "https://api.amplience.net/v2/content/content-items/cfc48d75-5cd4-42eb-ab52-2777deea2e8b/workflow"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa846e0fb036387e621/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa846e0fb036387e621/content-items/facet?createdDate.dir=desc&page=0&size=20&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa846e0fb036387e621/content-items/facet?createdDate.dir=desc&page=1&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7aa846e0fb036387e621/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/c38fdc61-7c73-4d2a-a170-c6f7bb832633/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/5e4d7a9b46e0fb036387e4ae

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/afa90b61-f53a-445b-97be-c5bfafb6b413/edition-slot-associations HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

{
  "contentItemId" : "afa90b61-f53a-445b-97be-c5bfafb6b413",
  "associations" : [ {
    "eventTitle" : "Test",
    "eventId" : "5e4d7a9846e0fb036387e2fa",
    "eventStart" : "2020-02-19T18:11:51.681Z",
    "eventEnd" : "2020-03-19T18:11:51.681Z",
    "editionTitle" : "Test",
    "editionId" : "5e4d7a9846e0fb036387e2fb",
    "editionStart" : "2020-02-19T18:11:51.681Z",
    "editionEnd" : "2020-03-19T18:11:51.681Z",
    "editionPubStatus" : "DRAFT",
    "editionSlotTitle" : "Simple Slot",
    "editionSlotId" : "5e4d7a9846e0fb036387e300",
    "editionSlotLocked" : true,
    "editionSlotLastModifiedDate" : "2020-02-19T18:12:40.993Z",
    "snapshotComments" : "This is an example snapshot.",
    "snapshotCreatedBy" : "user",
    "snapshotCreatedDate" : "2020-02-19T18:12:40.965Z",
    "snapshotId" : "5e4d7a9846e0fb036387e306",
    "usageCount" : 1,
    "snapshotLocale" : null,
    "_links" : {
      "get-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9846e0fb036387e2fb/slots/5e4d7a9846e0fb036387e300"
      },
      "update-content" : {
        "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9846e0fb036387e2fb/slots/5e4d7a9846e0fb036387e300/content{?lastModifiedDate,page,size,sort}",
        "templated" : true
      }
    }
  } ],
  "_links" : {
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/afa90b61-f53a-445b-97be-c5bfafb6b413/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/9c1f948b-4bb0-4b08-9735-4b7c8868a057/workflow HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 59

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "9c1f948b-4bb0-4b08-9735-4b7c8868a057",
  "workflow" : {
    "state" : "5e4d7ad046e0fb036387fa9b"
  },
  "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" : "2020-02-19T18:13:36.635Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:36.674Z",
  "deliveryId" : "9c1f948b-4bb0-4b08-9735-4b7c8868a057",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=9c1f948b-4bb0-4b08-9735-4b7c8868a057"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ad046e0fb036387fa99"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=9c1f948b-4bb0-4b08-9735-4b7c8868a057",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=9c1f948b-4bb0-4b08-9735-4b7c8868a057{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/9c1f948b-4bb0-4b08-9735-4b7c8868a057/workflow"
    }
  }
}

for more information on workflows see Workflows == Assigning a delivery key

You can assign a delivery key to a content item as long as it fits the validation rules for a delivery key and it does not already exist on the hub currently.

Auth rules

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

  • CONTENT:FUNCTIONAL:CONTENT_ITEM:EDIT

Required ACLs:
  • Hub - READ

  • ContentRepository - EDIT_CONTENT

Example request

PATCH /v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/delivery-key HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 49

{
  "deliveryKey" : "test/key",
  "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: 4092

{
  "id" : "c025a0e4-e0d4-4d86-b6f2-7305b101305e",
  "folderId" : null,
  "body" : {
    "_meta" : {
      "name" : "main-banner",
      "schema" : "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "deliveryKey" : "test/key"
    },
    "heading" : "Buy more stuff!!",
    "link" : "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version" : 2,
  "label" : "Banner Ad Homepage",
  "status" : "ACTIVE",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:12:42.029Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:42.064Z",
  "deliveryId" : "c025a0e4-e0d4-4d86-b6f2-7305b101305e",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=c025a0e4-e0d4-4d86-b6f2-7305b101305e"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7a9946e0fb036387e3c4"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=c025a0e4-e0d4-4d86-b6f2-7305b101305e",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c025a0e4-e0d4-4d86-b6f2-7305b101305e{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/workflow"
    },
    "set-delivery-key" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c025a0e4-e0d4-4d86-b6f2-7305b101305e/delivery-key"
    }
  }
}

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

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

Get an Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Get an Event with Editions

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

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

Listing Events

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

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

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

{
  "name" : "shoes",
  "start" : "2020-02-19T19:13:10.144Z",
  "end" : "2020-02-19T22:13:10.144Z",
  "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/5e4d7ab646e0fb036387ed34
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1239

{
  "id" : "5e4d7ab646e0fb036387ed34",
  "name" : "shoes",
  "comment" : "This is an event.",
  "start" : "2020-02-19T19:13:10.144Z",
  "end" : "2020-02-19T22:13:10.144Z",
  "brief" : "http://test/path2",
  "locales" : [ ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34"
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ed33"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34/archive"
    },
    "create-edition" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34/editions{?sourceEditionId}",
      "templated" : true
    },
    "editions" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7ab646e0fb036387ed34/editions{?page,size,sort}",
      "templated" : true
    }
  }
}

Delete an Event

Auth rules

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

Required ACLs:
  • Hub - READ

  • Hub - DELETE_EVENT

Example request

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

{
  "_embedded" : {
    "events" : [ {
      "id" : "5e4d7ab746e0fb036387ee41",
      "name" : "End On Range Start",
      "comment" : "This is an event.",
      "start" : "2020-02-13T18:13:10.807Z",
      "end" : "2020-02-16T18:13:10.807Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ee39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee41/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ab746e0fb036387ee3f",
      "name" : "Event 3",
      "comment" : "This is an event.",
      "start" : "2020-02-13T18:13:10.807Z",
      "end" : "2020-02-17T18:13:10.807Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ee39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3f/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ab746e0fb036387ee3d",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2020-02-19T18:13:10.807Z",
      "end" : "2020-02-21T18:13:10.807Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ee39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3d/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ab746e0fb036387ee3e",
      "name" : "Event 2",
      "comment" : "This is an event.",
      "start" : "2020-02-21T18:13:10.807Z",
      "end" : "2020-02-25T18:13:10.807Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ee39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee3e/editions{?page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ab746e0fb036387ee40",
      "name" : "Starts On Range End",
      "comment" : "This is an event.",
      "start" : "2020-02-22T18:13:10.807Z",
      "end" : "2020-02-25T18:13:10.807Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab646e0fb036387ee39"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee40/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7ab646e0fb036387ee39&rangeStart=2020-02-16T18:13:10.807Z&rangeEnd=2020-02-22T18:13:10.807Z&bounded=false&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7ab646e0fb036387ee39&rangeStart=2020-02-16T18:13:10.807Z&rangeEnd=2020-02-22T18:13:10.807Z&bounded=false&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7ab646e0fb036387ee39&rangeStart=2020-02-16T18:13:10.807Z&rangeEnd=2020-02-22T18:13:10.807Z&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=5e4d7abe46e0fb036387f53f&rangeEnd=2020-02-22T18:13:18.438Z&rangeStart=2020-02-16T18:13:18.438Z&bounded=0&projection=withEditions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3150

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

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

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

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

{
  "_embedded" : {
    "events" : [ {
      "id" : "5e4d7abf46e0fb036387f557",
      "name" : "Tomorrow",
      "comment" : "This is an event.",
      "start" : "2020-02-20T00:00:00.000Z",
      "end" : "2020-02-20T23:59:59.999Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7abe46e0fb036387f551"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abf46e0fb036387f557/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7abe46e0fb036387f551&rangeStart=2020-02-20T00:00:00.000Z&rangeEnd=2020-02-20T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7abe46e0fb036387f551&rangeStart=2020-02-20T00:00:00.000Z&rangeEnd=2020-02-20T23:59:59.999Z&bounded=true&page=0&size=1"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRange?hubId=5e4d7abe46e0fb036387f551&rangeStart=2020-02-20T00:00:00.000Z&rangeEnd=2020-02-20T23: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=5e4d7abe46e0fb036387f52c&rangeEnd=2020-02-22T18:13:18.099Z&rangeStart=2020-02-16T18:13:18.099Z&bounded=0&slots=a786dca4-92ae-4abc-a62e-7c9985d4b04c&locales=en-GB HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2563

{
  "_embedded" : {
    "events" : [ {
      "id" : "5e4d7abe46e0fb036387f530",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2020-02-19T18:13:18.099Z",
      "end" : "2020-02-21T18:13:18.099Z",
      "brief" : "http://host/test/brief",
      "locales" : [ "en-GB", "it" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7abe46e0fb036387f52c"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7abe46e0fb036387f530/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7abe46e0fb036387f52c&rangeStart=2020-02-16T18:13:18.099Z&rangeEnd=2020-02-22T18:13:18.099Z&bounded=false&slots=a786dca4-92ae-4abc-a62e-7c9985d4b04c&locales=en-GB&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7abe46e0fb036387f52c&rangeStart=2020-02-16T18:13:18.099Z&rangeEnd=2020-02-22T18:13:18.099Z&bounded=false&slots=a786dca4-92ae-4abc-a62e-7c9985d4b04c&locales=en-GB&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7abe46e0fb036387f52c&rangeStart=2020-02-16T18:13:18.099Z&rangeEnd=2020-02-22T18:13:18.099Z&bounded=false&slots=a786dca4-92ae-4abc-a62e-7c9985d4b04c&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=5e4d7ab746e0fb036387ee45&rangeEnd=2020-02-22T18:13:11.271Z&rangeStart=2020-02-16T18:13:11.271Z&bounded=0&projection=withEditions&slots=9a9cf2b4-8bd0-4d64-ac90-22ddb78eeda6&size=50 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 40630

{
  "_embedded" : {
    "events" : [ {
      "id" : "5e4d7ab746e0fb036387ee4b",
      "name" : "Event 1",
      "comment" : "This is an event.",
      "start" : "2020-02-19T18:13:11.271Z",
      "end" : "2020-02-21T18:13:11.271Z",
      "brief" : "http://host/test/brief",
      "locales" : [ ],
      "editions" : [ {
        "id" : "5e4d7ab746e0fb036387ee4c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.470Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.471Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.506Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee4e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.522Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.523Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.555Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee51",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.573Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.574Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.611Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee55",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.629Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.630Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.657Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee5a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.670Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.671Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.701Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee60",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.713Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.713Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.741Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee67",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.753Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.753Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.787Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee6f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.799Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.799Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.834Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee78",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.845Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.846Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.878Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee82",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.890Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.890Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.924Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee8d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.937Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.937Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:11.971Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab746e0fb036387ee99",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:11.983Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:11.984Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.025Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eea6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.037Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.037Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.144Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eeb4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.156Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.157Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.198Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eec3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.211Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.211Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.247Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eed3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.260Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.261Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.298Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eee4",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.310Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.310Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.361Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387eef6",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.375Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.375Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.411Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef09",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.423Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.423Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.466Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef1d",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.477Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.478Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.538Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef32",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.550Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.550Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.590Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef48",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.602Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.602Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.651Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef5f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.667Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.667Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.710Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef77",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.722Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.723Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.766Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387ef90",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.777Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.778Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.823Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387efaa",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.835Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.836Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.882Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387efc5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.894Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.895Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:12.939Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab846e0fb036387efe1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:12.951Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:12.951Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.001Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387effe",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.014Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.015Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.080Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f01c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.096Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.097Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.172Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f03b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.195Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.196Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.264Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f05b",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.283Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.283Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.338Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f07c",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.355Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.356Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.496Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f09e",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.537Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.539Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.632Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f0c1",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.648Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.649Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.756Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f0e5",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.793Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.794Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.892Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f10a",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.906Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.907Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:13.965Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7ab946e0fb036387f130",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:13.977Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:13.978Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.038Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f157",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.050Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.051Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.109Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f17f",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.131Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.132Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.196Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f1a8",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.208Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.209Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.268Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f1d2",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.279Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.280Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.336Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f1fd",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.348Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.349Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.411Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f229",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.423Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.424Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.489Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f256",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.504Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.504Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.593Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f284",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.605Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.606Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.668Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f2b3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.680Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.680Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.741Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f2e3",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.752Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.753Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.826Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f314",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.842Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.842Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.909Z",
        "stagedDate" : null,
        "slotCollisions" : true
      }, {
        "id" : "5e4d7aba46e0fb036387f346",
        "name" : "Test",
        "comment" : "This is an example edition.",
        "start" : "2020-02-19T18:13:11.271Z",
        "end" : "2020-02-21T18:13:11.271Z",
        "eventId" : "5e4d7ab746e0fb036387ee4b",
        "publishingStatus" : "DRAFT",
        "slotsRemaining" : 199,
        "schedulingErrors" : null,
        "activeEndDate" : false,
        "publishingJobId" : null,
        "statusUpdated" : "2020-02-19T18:13:14.922Z",
        "schedulingUser" : null,
        "createdBy" : "user",
        "createdDate" : "2020-02-19T18:13:14.922Z",
        "lastModifiedBy" : "user",
        "lastModifiedDate" : "2020-02-19T18:13:14.984Z",
        "stagedDate" : null,
        "slotCollisions" : true
      } ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b"
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab746e0fb036387ee45"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b"
        },
        "archive" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b/archive"
        },
        "create-edition" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b/editions{?sourceEditionId}",
          "templated" : true
        },
        "editions" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7ab746e0fb036387ee4b/editions{?page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7ab746e0fb036387ee45&rangeStart=2020-02-16T18:13:11.271Z&rangeEnd=2020-02-22T18:13:11.271Z&bounded=false&slots=9a9cf2b4-8bd0-4d64-ac90-22ddb78eeda6&page=0&size=50"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7ab746e0fb036387ee45&rangeStart=2020-02-16T18:13:11.271Z&rangeEnd=2020-02-22T18:13:11.271Z&bounded=false&slots=9a9cf2b4-8bd0-4d64-ac90-22ddb78eeda6&page=0&size=50"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots?hubId=5e4d7ab746e0fb036387ee45&rangeStart=2020-02-16T18:13:11.271Z&rangeEnd=2020-02-22T18:13:11.271Z&bounded=false&slots=9a9cf2b4-8bd0-4d64-ac90-22ddb78eeda6&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/5e4d7ab646e0fb036387ed8b/editions HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 179

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

Example response

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

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

{
  "name" : "Test",
  "start" : "2020-02-19T18:11:51.681Z",
  "end" : "2020-03-19T18:11:51.681Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

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

Listing Editions

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:13:10 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2549

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

{
  "name" : "New Name",
  "start" : "2020-02-19T18:11:51.681Z",
  "end" : "2020-02-25T18:11:51.681Z",
  "activeEndDate" : false,
  "comment" : "This is an example edition."
}

Example response

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

{
  "id" : "5e4d7a7746e0fb036387dcdc",
  "name" : "New Name",
  "comment" : "This is an example edition.",
  "start" : "2020-02-19T18:11:51.681Z",
  "end" : "2020-02-25T18:11:51.681Z",
  "eventId" : "5e4d7a7746e0fb036387dcdb",
  "publishingStatus" : "DRAFT",
  "slotsRemaining" : 200,
  "schedulingErrors" : null,
  "activeEndDate" : false,
  "publishingJobId" : null,
  "statusUpdated" : "2020-02-19T18:12:07.234Z",
  "schedulingUser" : null,
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:12:07.235Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:12:07.283Z",
  "stagedDate" : null,
  "slotCollisions" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc"
    },
    "create-preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/preview"
    },
    "preview" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/preview"
    },
    "schedule" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/schedule{?ignoreWarnings}",
      "templated" : true
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc"
    },
    "list-slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/slots{?includedSlots}",
      "templated" : true
    },
    "slots" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/slots"
    },
    "copy-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/slots{?sourceEditionSlotId}",
      "templated" : true
    },
    "event" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7a7746e0fb036387dcdb"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/conflicts"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/conflicts/findByIdAndVersion{?id,version}",
      "templated" : true
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dcdc/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/5e4d7a8746e0fb036387dfab 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/5e4d7a9346e0fb036387e07b/schedule HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 53

{
  "lastModifiedDate" : "2020-02-19T18:12:36.143Z"
}

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

{
  "lastModifiedDate" : "2020-02-19T18:12:22.317Z",
  "type" : "QUICKPREVIEW"
}

Example response

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

{
  "snapshotId" : "5e4d7a8646e0fb036387dee5",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a8646e0fb036387dee5"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a8646e0fb036387dee5"
    }
  }
}

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

Example response

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

{
  "snapshotId" : "5e4d7a8746e0fb036387df53",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a8746e0fb036387df53"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a8746e0fb036387df53"
    }
  }
}

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/5e4d7a7846e0fb036387ddff/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/5e4d7a7846e0fb036387dd99/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=5e4d7a7846e0fb036387dd99{&page,size,sort}",
      "templated" : true
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/events/5e4d7a7846e0fb036387dd99/editions/search"
    }
  }
}

Find By Event

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5e4d7a7846e0fb036387dd9b",
      "name" : "Edition #2",
      "comment" : "This is an example edition.",
      "start" : "2020-02-19T18:11:51.681Z",
      "end" : "2020-02-19T20:11:51.681Z",
      "eventId" : "5e4d7a7846e0fb036387dd99",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2020-02-19T18:12:08.084Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:12:08.085Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:08.085Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7a7846e0fb036387dd99"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9b/slot-collisions"
        }
      }
    }, {
      "id" : "5e4d7a7846e0fb036387dd9a",
      "name" : "Edition #1",
      "comment" : "This is an example edition.",
      "start" : "2020-02-19T19:11:51.681Z",
      "end" : "2020-02-19T20:11:51.681Z",
      "eventId" : "5e4d7a7846e0fb036387dd99",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2020-02-19T18:12:08.070Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:12:08.071Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:08.071Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7a7846e0fb036387dd99"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9a/slot-collisions"
        }
      }
    }, {
      "id" : "5e4d7a7846e0fb036387dd9c",
      "name" : "Edition #3",
      "comment" : "This is an example edition.",
      "start" : "2020-02-19T19:11:52.681Z",
      "end" : "2020-02-19T20:11:51.681Z",
      "eventId" : "5e4d7a7846e0fb036387dd99",
      "publishingStatus" : "DRAFT",
      "slotsRemaining" : 200,
      "schedulingErrors" : null,
      "activeEndDate" : false,
      "publishingJobId" : null,
      "statusUpdated" : "2020-02-19T18:12:08.097Z",
      "schedulingUser" : null,
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:12:08.098Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:12:08.098Z",
      "stagedDate" : null,
      "slotCollisions" : false,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c"
        },
        "create-preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/preview"
        },
        "preview" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/preview"
        },
        "schedule" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/schedule{?ignoreWarnings}",
          "templated" : true
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c"
        },
        "list-slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/slots{?includedSlots}",
          "templated" : true
        },
        "slots" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/slots"
        },
        "copy-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/slots{?sourceEditionSlotId}",
          "templated" : true
        },
        "event" : {
          "href" : "https://api.amplience.net/v2/content/events/5e4d7a7846e0fb036387dd99"
        },
        "edition-conflicts" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/conflicts"
        },
        "edition-conflict" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/conflicts/findByIdAndVersion{?id,version}",
          "templated" : true
        },
        "slot-collisions" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7846e0fb036387dd9c/slot-collisions"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5e4d7a7846e0fb036387dd99&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5e4d7a7846e0fb036387dd99&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=5e4d7a7846e0fb036387dd99&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/5e4d7a9846e0fb036387e29c/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" : "33fd74cf-9437-4d40-b2ae-09d75ee2e7a4",
    "contentItemLabel" : "Banner Ad Homepage",
    "versions" : [ {
      "version" : 1,
      "instances" : 1,
      "slots" : 1
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9846e0fb036387e29c/conflicts"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9846e0fb036387e29c"
    },
    "edition-conflict" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9846e0fb036387e29c/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/5e4d7a9746e0fb036387e235/conflicts/findByIdAndVersion?id=5a35b52c-38ee-408f-990a-23816014e817&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" : "5e4d7a9746e0fb036387e235",
  "contentItemId" : "5a35b52c-38ee-408f-990a-23816014e817",
  "version" : 1,
  "instances" : [ {
    "snapshot" : {
      "snapshotId" : "5e4d7a9746e0fb036387e236",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:12:39.461Z",
      "comment" : "This is an example snapshot."
    },
    "slotId" : "5e4d7a9746e0fb036387e238",
    "slotLabel" : "Simple Slot",
    "itemHierarchy" : [ {
      "contentItemId" : "5a35b52c-38ee-408f-990a-23816014e817",
      "version" : 1,
      "label" : "Banner Ad Homepage"
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9746e0fb036387e235/conflicts/findByIdAndVersion?id=5a35b52c-38ee-408f-990a-23816014e817&version=1"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9746e0fb036387e235"
    },
    "edition-conflicts" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a9746e0fb036387e235/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/5e4d7a9646e0fb036387e1c2/conflicts HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 194

{
  "comment" : "Do that thing!",
  "lastModifiedDate" : "2020-02-19T18:12:38.637Z",
  "resolutions" : [ {
    "contentItemId" : "46cc7896-9dea-42ee-9368-fef270a09ceb",
    "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/5e4d7a7746e0fb036387dd3c/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" : "5e4d7a7746e0fb036387dd3c",
  "editionSlotCollisionResponseEntries" : [ {
    "editionName" : "Test Edition #1",
    "startDateTime" : "2020-02-19T18:11:51.681Z",
    "endDateTime" : "2020-03-19T18:11:51.681Z",
    "editionId" : "5e4d7a7746e0fb036387dd37",
    "collidingSlotIds" : [ "acdc3b60-3b30-4a78-abac-0dfa6b422c97", "b961826d-9e04-4287-9f3b-fdabe2853922" ],
    "eventName" : "Test",
    "eventId" : "5e4d7a7746e0fb036387dd36"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dd3c/slot-collisions"
    },
    "slot-collisions" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a7746e0fb036387dd3c/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/5e4d7ac046e0fb036387f670/slots?sourceEditionSlotId=5e4d7ac046e0fb036387f66e HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

sourceEditionSlotId=5e4d7ac046e0fb036387f66e

Example response

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

{
  "id" : "5e4d7ac046e0fb036387f671",
  "eventId" : "5e4d7ac046e0fb036387f66f",
  "editionId" : "5e4d7ac046e0fb036387f670",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:13:20.926Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:20.926Z",
  "content" : {
    "body" : {
      "_meta" : {
        "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
        "name" : "slot"
      }
    }
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5e4d7ac046e0fb036387f666",
  "slotId" : "8214b853-23aa-43c1-b8eb-4e7ccbe6d869",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ac046e0fb036387f670/slots/5e4d7ac046e0fb036387f671"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ac046e0fb036387f670/slots/5e4d7ac046e0fb036387f671"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ac046e0fb036387f670"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/8214b853-23aa-43c1-b8eb-4e7ccbe6d869{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ac046e0fb036387f670/slots/5e4d7ac046e0fb036387f671/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ac046e0fb036387f670/slots/5e4d7ac046e0fb036387f671/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/5e4d7acd46e0fb036387f743/content-items HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 169

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

Example response

HTTP/1.1 201 Created
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:13:33 GMT
Location: https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3792

{
  "id" : "93e0f8b2-2e22-4a89-904a-853b0c45fe62",
  "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" : "2020-02-19T18:13:33.114Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:33.114Z",
  "deliveryId" : "93e0f8b2-2e22-4a89-904a-853b0c45fe62",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=93e0f8b2-2e22-4a89-904a-853b0c45fe62"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7acd46e0fb036387f743"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=93e0f8b2-2e22-4a89-904a-853b0c45fe62",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=93e0f8b2-2e22-4a89-904a-853b0c45fe62{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62/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/5e4d7ace46e0fb036387f875/slots HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 167

[ {
  "slot" : "1fbc4df1-6004-4fa5-aeee-3f354a2923ab"
}, {
  "slot" : "f7ac3bff-c855-4376-afcb-8b30907a7fc0"
}, {
  "slot" : "6e32d9cb-247e-4526-9ffc-b264cd4be1b3"
} ]

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

{
  "_embedded" : {
    "edition-slots" : [ {
      "id" : "5e4d7acf46e0fb036387f879",
      "eventId" : "5e4d7ace46e0fb036387f874",
      "editionId" : "5e4d7ace46e0fb036387f875",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:35.007Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:35.007Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5e4d7ace46e0fb036387f873",
      "slotId" : "1fbc4df1-6004-4fa5-aeee-3f354a2923ab",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f879"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f879"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1fbc4df1-6004-4fa5-aeee-3f354a2923ab{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f879/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f879/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7acf46e0fb036387f87a",
      "eventId" : "5e4d7ace46e0fb036387f874",
      "editionId" : "5e4d7ace46e0fb036387f875",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:35.008Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:35.008Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5e4d7ace46e0fb036387f873",
      "slotId" : "f7ac3bff-c855-4376-afcb-8b30907a7fc0",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87a"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87a"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f7ac3bff-c855-4376-afcb-8b30907a7fc0{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87a/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87a/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7acf46e0fb036387f87b",
      "eventId" : "5e4d7ace46e0fb036387f874",
      "editionId" : "5e4d7ace46e0fb036387f875",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:35.008Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:35.008Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5e4d7ace46e0fb036387f873",
      "slotId" : "6e32d9cb-247e-4526-9ffc-b264cd4be1b3",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87b"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87b"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/6e32d9cb-247e-4526-9ffc-b264cd4be1b3{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87b/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots/5e4d7acf46e0fb036387f87b/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f875/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/5e4d7ace46e0fb036387f868/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" : "5e4d7ace46e0fb036387f86e",
      "eventId" : "5e4d7ace46e0fb036387f867",
      "editionId" : "5e4d7ace46e0fb036387f868",
      "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" : "5e4d7ace46e0fb036387f866",
      "slotId" : "7d3fff2c-aa6c-436f-bf4b-303617c9000b",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86e"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86e"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/7d3fff2c-aa6c-436f-bf4b-303617c9000b{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86e/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86e/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ace46e0fb036387f86c",
      "eventId" : "5e4d7ace46e0fb036387f867",
      "editionId" : "5e4d7ace46e0fb036387f868",
      "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" : "5e4d7ace46e0fb036387f866",
      "slotId" : "e756c737-87e9-408d-b5f6-cd629d9f9472",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86c"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86c"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/e756c737-87e9-408d-b5f6-cd629d9f9472{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86c/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86c/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7ace46e0fb036387f86a",
      "eventId" : "5e4d7ace46e0fb036387f867",
      "editionId" : "5e4d7ace46e0fb036387f868",
      "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" : "5e4d7ace46e0fb036387f866",
      "slotId" : "b69f5038-6dde-4402-8c30-fdbc717d5cdc",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86a"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86a"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/b69f5038-6dde-4402-8c30-fdbc717d5cdc{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86a/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots/5e4d7ace46e0fb036387f86a/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/slots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f868/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/5e4d7acf46e0fb036387f8d9/slots?includedSlots=1e3e5c42-194c-4fab-88ef-58b635fa288e HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5e4d7acf46e0fb036387f8db",
      "eventId" : "5e4d7acf46e0fb036387f8d5",
      "editionId" : "5e4d7acf46e0fb036387f8d9",
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:35.491Z",
      "lastModifiedBy" : "user",
      "lastModifiedDate" : "2020-02-19T18:13:35.491Z",
      "content" : {
        "body" : {
          "_meta" : {
            "schema" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
            "name" : "slot"
          }
        }
      },
      "status" : "VALID",
      "slotStatus" : "ACTIVE",
      "contentTypeId" : "5e4d7acf46e0fb036387f8d4",
      "slotId" : "1e3e5c42-194c-4fab-88ef-58b635fa288e",
      "slotLabel" : "Simple Slot",
      "conflicts" : false,
      "locale" : null,
      "empty" : true,
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots/5e4d7acf46e0fb036387f8db"
        },
        "edition-slot" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots/5e4d7acf46e0fb036387f8db"
        },
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9"
        },
        "slot" : {
          "href" : "https://api.amplience.net/v2/content/content-items/1e3e5c42-194c-4fab-88ef-58b635fa288e{?projection}",
          "templated" : true
        },
        "content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots/5e4d7acf46e0fb036387f8db/content"
        },
        "safe-update-content" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots/5e4d7acf46e0fb036387f8db/content{?lastModifiedDate,page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots?includedSlots=1e3e5c42-194c-4fab-88ef-58b635fa288e&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots?includedSlots=1e3e5c42-194c-4fab-88ef-58b635fa288e&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acf46e0fb036387f8d9/slots?includedSlots=1e3e5c42-194c-4fab-88ef-58b635fa288e&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/5e4d7ace46e0fb036387f804/slots/5e4d7ace46e0fb036387f806 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-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" : "5e4d7ace46e0fb036387f806",
  "eventId" : "5e4d7ace46e0fb036387f803",
  "editionId" : "5e4d7ace46e0fb036387f804",
  "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" : "5e4d7acd46e0fb036387f802",
  "slotId" : "c0b037b3-a996-4378-b0fb-401a5970ea91",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f804/slots/5e4d7ace46e0fb036387f806"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f804/slots/5e4d7ace46e0fb036387f806"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f804"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c0b037b3-a996-4378-b0fb-401a5970ea91{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f804/slots/5e4d7ace46e0fb036387f806/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7ace46e0fb036387f804/slots/5e4d7ace46e0fb036387f806/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/5e4d7acd46e0fb036387f7a7/slots/5e4d7acd46e0fb036387f7a9 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/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745/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" : "c20679df-2be9-44b1-958b-9cbad3ce5d60",
        "locked" : true
      },
      "id" : "5e4d7acd46e0fb036387f74b",
      "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: Wed, 19 Feb 2020 18:13:33 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5e4d7acd46e0fb036387f745",
  "eventId" : "5e4d7acd46e0fb036387f73f",
  "editionId" : "5e4d7acd46e0fb036387f740",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:13:33.147Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:33.321Z",
  "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" : "c20679df-2be9-44b1-958b-9cbad3ce5d60",
          "locked" : true
        },
        "id" : "5e4d7acd46e0fb036387f74b",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5e4d7acd46e0fb036387f742",
  "slotId" : "93e0f8b2-2e22-4a89-904a-853b0c45fe62",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745/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/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:13:33 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 2056

{
  "id" : "5e4d7acd46e0fb036387f745",
  "eventId" : "5e4d7acd46e0fb036387f73f",
  "editionId" : "5e4d7acd46e0fb036387f740",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:13:33.147Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:33.321Z",
  "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" : "c20679df-2be9-44b1-958b-9cbad3ce5d60",
          "locked" : true
        },
        "id" : "5e4d7acd46e0fb036387f74b",
        "contentType" : "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      }
    },
    "label" : "Simple Slot"
  },
  "status" : "VALID",
  "slotStatus" : "ACTIVE",
  "contentTypeId" : "5e4d7acd46e0fb036387f742",
  "slotId" : "93e0f8b2-2e22-4a89-904a-853b0c45fe62",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : false,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/93e0f8b2-2e22-4a89-904a-853b0c45fe62{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acd46e0fb036387f740/slots/5e4d7acd46e0fb036387f745/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/5e4d7acc46e0fb036387f737/slots/5e4d7acc46e0fb036387f73c HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:13:32 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1702

{
  "id" : "5e4d7acc46e0fb036387f73c",
  "eventId" : "5e4d7acc46e0fb036387f736",
  "editionId" : "5e4d7acc46e0fb036387f737",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:13:32.863Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:32.931Z",
  "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" : "5e4d7acc46e0fb036387f739",
  "slotId" : "6e8163ce-89af-41f2-bf72-bd725b588650",
  "slotLabel" : "Simple Slot",
  "conflicts" : false,
  "locale" : null,
  "empty" : true,
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acc46e0fb036387f737/slots/5e4d7acc46e0fb036387f73c"
    },
    "edition-slot" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acc46e0fb036387f737/slots/5e4d7acc46e0fb036387f73c"
    },
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acc46e0fb036387f737"
    },
    "slot" : {
      "href" : "https://api.amplience.net/v2/content/content-items/6e8163ce-89af-41f2-bf72-bd725b588650{?projection}",
      "templated" : true
    },
    "content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acc46e0fb036387f737/slots/5e4d7acc46e0fb036387f73c/content"
    },
    "safe-update-content" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7acc46e0fb036387f737/slots/5e4d7acc46e0fb036387f73c/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/5e4d7a7146e0fb036387d7ea/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" : "c9c6f877-645f-4490-9130-93cae47ac8a8",
  "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/5e4d7a7146e0fb036387d7f1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1583

{
  "id" : "5e4d7a7146e0fb036387d7f1",
  "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" : "c9c6f877-645f-4490-9130-93cae47ac8a8"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7146e0fb036387d7ea"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/c9c6f877-645f-4490-9130-93cae47ac8a8"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7146e0fb036387d7f1/content-items{/id}",
      "templated" : true
    }
  }
}

Listing Snapshots

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

GET /v2/content/hubs/5e4d7a7046e0fb036387d77f/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" : "5e4d7a7046e0fb036387d786",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2020-02-19T18:12:00.799Z",
      "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" : "74c84f88-c9c6-49ea-bb81-87980a1f06f3"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/74c84f88-c9c6-49ea-bb81-87980a1f06f3"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d786/content-items{/id}",
          "templated" : true
        }
      }
    }, {
      "id" : "5e4d7a7046e0fb036387d787",
      "comment" : "This is an example snapshot.",
      "createdDate" : "2020-02-19T18:12:00.813Z",
      "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" : "48db3b78-8a87-4a08-822f-7fef41481051"
      },
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787"
        },
        "publishing-jobs" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787/publishing-jobs{?page,size,sort}",
          "templated" : true
        },
        "create-publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787/publishing-jobs"
        },
        "edition-links" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787/edition-links"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f"
        },
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/48db3b78-8a87-4a08-822f-7fef41481051"
        },
        "snapshot-content-item" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a7046e0fb036387d787/content-items{/id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f/snapshots?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f/snapshots?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f/snapshots?page=0&size=20"
    },
    "search" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7046e0fb036387d77f/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/5e4d7a6d46e0fb036387d644 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "5e4d7a6d46e0fb036387d644",
  "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" : "761ce1ae-711a-4de6-8b0a-4f7cd9cb9366"
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644"
    },
    "publishing-jobs" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644/publishing-jobs{?page,size,sort}",
      "templated" : true
    },
    "create-publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644/publishing-jobs"
    },
    "edition-links" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644/edition-links"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a6d46e0fb036387d63e"
    },
    "content-root" : {
      "href" : "https://api.amplience.net/v2/content/content-items/761ce1ae-711a-4de6-8b0a-4f7cd9cb9366"
    },
    "snapshot-content-item" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6d46e0fb036387d644/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/5e4d7a6f46e0fb036387d6c8/edition-links HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 44

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

{
  "editionId" : "5e4d7a6f46e0fb036387d6c7",
  "createdDate" : "2020-02-19T18:11:59Z",
  "createdBy" : "thor",
  "_links" : {
    "edition" : {
      "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6f46e0fb036387d6c7"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6f46e0fb036387d6c8/edition-links/5e4d7a6f46e0fb036387d6c7"
    }
  }
}
Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5e4d7a6e46e0fb036387d6a2/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" : "5e4d7a6e46e0fb036387d6a8",
      "createdDate" : "2020-02-19T18:11:59Z",
      "createdBy" : "user5",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6e46e0fb036387d6a8"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links/5e4d7a6e46e0fb036387d6a8"
        }
      }
    }, {
      "editionId" : "5e4d7a6e46e0fb036387d6a9",
      "createdDate" : "2020-02-19T18:11:59Z",
      "createdBy" : "user6",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6e46e0fb036387d6a9"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links/5e4d7a6e46e0fb036387d6a9"
        }
      }
    }, {
      "editionId" : "5e4d7a6e46e0fb036387d6aa",
      "createdDate" : "2020-02-19T18:11:59Z",
      "createdBy" : "user7",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6e46e0fb036387d6aa"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links/5e4d7a6e46e0fb036387d6aa"
        }
      }
    }, {
      "editionId" : "5e4d7a6e46e0fb036387d6ab",
      "createdDate" : "2020-02-19T18:11:59Z",
      "createdBy" : "user8",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6e46e0fb036387d6ab"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links/5e4d7a6e46e0fb036387d6ab"
        }
      }
    }, {
      "editionId" : "5e4d7a6e46e0fb036387d6ac",
      "createdDate" : "2020-02-19T18:11:59Z",
      "createdBy" : "user9",
      "_links" : {
        "edition" : {
          "href" : "https://api.amplience.net/v2/content/editions/5e4d7a6e46e0fb036387d6ac"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links/5e4d7a6e46e0fb036387d6ac"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links?page=0&size=5"
    },
    "prev" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links?page=0&size=5"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links?page=1&size=5"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/edition-links?page=2&size=5"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7a6e46e0fb036387d6a2/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/5e4d7ab546e0fb036387ec22/publishing-jobs HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 46

{
  "scheduledDate" : "2020-02-19T19:13:09Z"
}
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/5e4d7ab546e0fb036387ec23
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 677

{
  "id" : "5e4d7ab546e0fb036387ec23",
  "scheduledDate" : "2020-02-19T19:13:09.000Z",
  "createdDate" : "2017-06-05T04:03:02.000Z",
  "createdBy" : "user",
  "state" : "CREATED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec23"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec23"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab546e0fb036387ec22"
    },
    "cancel" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec23"
    }
  }
}

Retrieving a Publishing-Job for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

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

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/5e4d7ab646e0fb036387ecdd 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" : "5e4d7ab646e0fb036387ecdd",
  "scheduledDate" : "2020-03-19T18:13:10.025Z",
  "createdDate" : "2020-02-19T18:13:10.032Z",
  "createdBy" : "user",
  "state" : "CANCELLED",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab646e0fb036387ecdd"
    },
    "publishing-job" : {
      "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab646e0fb036387ecdd"
    },
    "snapshot" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab646e0fb036387ecdc"
    }
  }
}

Listing all Publishing-Jobs for a Snapshot

Auth rules
Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request
GET /v2/content/snapshots/5e4d7ab546e0fb036387ec7f/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" : "5e4d7ab546e0fb036387ec80",
      "scheduledDate" : "2020-02-19T20:13:09.307Z",
      "createdDate" : "2017-06-05T04:03:02.000Z",
      "createdBy" : "user",
      "state" : "CREATED",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec80"
        },
        "publishing-job" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec80"
        },
        "snapshot" : {
          "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab546e0fb036387ec7f"
        },
        "cancel" : {
          "href" : "https://api.amplience.net/v2/content/publishing-jobs/5e4d7ab546e0fb036387ec80"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab546e0fb036387ec7f/publishing-jobs?page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab546e0fb036387ec7f/publishing-jobs?page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/snapshots/5e4d7ab546e0fb036387ec7f/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/5e4d7a5546e0fb036387bde4/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/5e4d7a5546e0fb036387bde5
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1058

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

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

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

Get a folder

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

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

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

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/5e4d7aae46e0fb036387e727/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: Wed, 19 Feb 2020 18:13:03 GMT
Location: https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 3928

{
  "id" : "7c459358-8340-4699-a50d-9cc5caf937ca",
  "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" : "2020-02-19T18:13:03.052Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:03.052Z",
  "deliveryId" : "7c459358-8340-4699-a50d-9cc5caf937ca",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=7c459358-8340-4699-a50d-9cc5caf937ca"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aae46e0fb036387e727"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=7c459358-8340-4699-a50d-9cc5caf937ca",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=7c459358-8340-4699-a50d-9cc5caf937ca{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/7c459358-8340-4699-a50d-9cc5caf937ca/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/a8070e2f-5163-4690-8459-488747ce4f57/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" : "a8070e2f-5163-4690-8459-488747ce4f57",
  "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" : "2020-02-19T18:13:02.682Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:02.767Z",
  "deliveryId" : "a8070e2f-5163-4690-8459-488747ce4f57",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57"
    },
    "content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57{?projection}",
      "templated" : true
    },
    "planned" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/planned{?epoch,time}",
      "templated" : true
    },
    "publish" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/publish"
    },
    "content-item-with-children" : {
      "href" : "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=a8070e2f-5163-4690-8459-488747ce4f57"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57"
    },
    "restore-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/restore"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7aae46e0fb036387e71c"
    },
    "content-item-version" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/versions{/version}",
      "templated" : true
    },
    "content-item-versions" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/versions{?page,size,sort}",
      "templated" : true
    },
    "content-item-history" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/history{?page,size,sort}",
      "templated" : true
    },
    "copy" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=a8070e2f-5163-4690-8459-488747ce4f57",
      "templated" : true
    },
    "unarchive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/unarchive"
    },
    "archive" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/archive"
    },
    "set-locale" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/locale"
    },
    "create-localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/localize"
    },
    "localizations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/localizations{?page,size,sort}",
      "templated" : true
    },
    "localization-jobs" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=a8070e2f-5163-4690-8459-488747ce4f57{&page,size,sort}",
      "templated" : true
    },
    "edition-slot-associations" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/edition-slot-associations"
    },
    "edit-workflow" : {
      "href" : "https://api.amplience.net/v2/content/content-items/a8070e2f-5163-4690-8459-488747ce4f57/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/df5b46e6-27d7-409e-b302-1047dfc8daf6/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" : "df5b46e6-27d7-409e-b302-1047dfc8daf6"
  },
  "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/df5b46e6-27d7-409e-b302-1047dfc8daf6"
    },
    "findByRootContentItem" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=df5b46e6-27d7-409e-b302-1047dfc8daf6{&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/4b58ac56-b519-460b-bed5-47a63b3029fd/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" : "4b58ac56-b519-460b-bed5-47a63b3029fd",
      "locale" : "en",
      "createdBy" : "user",
      "createdDate" : "2018-01-01T01:01:01.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/4b58ac56-b519-460b-bed5-47a63b3029fd"
        }
      }
    }, {
      "id" : "f5f6b646-4759-4077-88ea-f8b81629c229",
      "locale" : "fr",
      "createdBy" : "user",
      "createdDate" : "2018-02-02T02:02:02.000Z",
      "_links" : {
        "content-item" : {
          "href" : "https://api.amplience.net/v2/content/content-items/f5f6b646-4759-4077-88ea-f8b81629c229"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b58ac56-b519-460b-bed5-47a63b3029fd/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b58ac56-b519-460b-bed5-47a63b3029fd/localizations?page=0&size=20&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/content-items/4b58ac56-b519-460b-bed5-47a63b3029fd/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=c4439ddf-c4da-4e58-93b6-7ec32d1406ce HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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" : "c4439ddf-c4da-4e58-93b6-7ec32d1406ce"
      },
      "requestedLocales" : [ "fr-FR", "de-DE" ],
      "createdBy" : "user",
      "createdDate" : "2020-02-19T18:13:35.883Z",
      "_links" : {
        "content-root" : {
          "href" : "https://api.amplience.net/v2/content/content-items/c4439ddf-c4da-4e58-93b6-7ec32d1406ce"
        },
        "findByRootContentItem" : {
          "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c4439ddf-c4da-4e58-93b6-7ec32d1406ce{&page,size,sort}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c4439ddf-c4da-4e58-93b6-7ec32d1406ce&page=0&size=20"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c4439ddf-c4da-4e58-93b6-7ec32d1406ce&page=0&size=20"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=c4439ddf-c4da-4e58-93b6-7ec32d1406ce&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/5e4d7ab446e0fb036387eb2a/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" : "5e4d7ab446e0fb036387eb2a",
  "name" : "inspiration",
  "label" : "Inspiration",
  "status" : "ACTIVE",
  "features" : [ ],
  "type" : "CONTENT",
  "contentTypes" : [ ],
  "itemLocales" : [ "en", "fr" ],
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a"
    },
    "content-repository" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab446e0fb036387eb29"
    },
    "create-content-item" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/content-items"
    },
    "search-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab446e0fb036387eb29/content-items/find{?page,projection,query,size,sort}",
      "templated" : true
    },
    "facet-content-items" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ab446e0fb036387eb29/content-items/facet{?page,projection,query,size,sort}",
      "templated" : true
    },
    "content-items" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/content-items{?folderId,page,projection,size,sort,status}",
      "templated" : true
    },
    "share" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/share"
    },
    "assign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/content-types"
    },
    "unassign-content-type" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/content-types/{id}",
      "templated" : true
    },
    "folders" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/folders{?page,size,sort}",
      "templated" : true
    },
    "create-folder" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/folders"
    },
    "features" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/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/5e4d7ab446e0fb036387eb2a/item-locales"
    },
    "join-localization-group" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/localization-group"
    },
    "localization-group-locales" : {
      "href" : "https://api.amplience.net/v2/content/content-repositories/5e4d7ab446e0fb036387eb2a/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/5e4d7ab246e0fb036387e961/localization-group HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 52

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

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

Administration

Listing Administrative Operations

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

The following operations are available based on your permissions

Table 5. Operations
Operation rel

Manage Access

"access"

Auth rules

Required Functional Permissions:
  • none

Example request

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

Example response

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

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

Managing Access

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

Auth rules

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

Example request

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

Example response

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

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

Listing operations for a resource

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

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

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

  • CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESS

Required ACLs:
  • Hub - READ

  • Hub - MANAGE_ACCESS

Example request
GET /v2/content/admin/access/hubs/5e4d7a6646e0fb036387ccd2 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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/5e4d7a6646e0fb036387ccd2"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387ccd2/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387ccd2/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/5e4d7a6646e0fb036387ccd0 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Example response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, 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/5e4d7a6646e0fb036387ccd0"
    },
    "members" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6646e0fb036387ccd0/members"
    },
    "member" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6646e0fb036387ccd0/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/5e4d7a6646e0fb036387cd28/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/5e4d7a6646e0fb036387cd28/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/bob/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "charlie",
      "permissions" : [ "READ", "CREATE_REPOSITORY" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6646e0fb036387cd28/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/5e4d7a6746e0fb036387cd2b/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/5e4d7a6746e0fb036387cd2b/members/alice"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/alice/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "bob",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/bob"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/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/5e4d7a6746e0fb036387cd2b/members/charlie"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/charlie/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "david",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/david"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/david/permissions/{permission}",
          "templated" : true
        }
      }
    }, {
      "sid" : "ewan",
      "permissions" : [ "READ" ],
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/ewan"
        },
        "revoke-permission" : {
          "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/members/ewan/permissions/{permission}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/content-repositories/5e4d7a6746e0fb036387cd2b/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/5e4d7a6746e0fb036387cd81/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/5e4d7a6746e0fb036387cd81/members/alice"
    },
    "revoke-permission" : {
      "href" : "https://api.amplience.net/v2/content/admin/access/hubs/5e4d7a6746e0fb036387cd81/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/5e4d7a6546e0fb036387cc23/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/5e4d7a6646e0fb036387cc25/members/alice/permissions/READ,EDIT HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net

Example response

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

Webhooks

A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST.

Creating a new Webhook for a Hub

Supported event names that will be accepted by the events array when creating a new webhook:

Event name Event label

dynamic-content.snapshot.published

Snapshot - published

dynamic-content.edition.scheduled

Edition - scheduled

dynamic-content.edition.unscheduled

Edition - unscheduled

dynamic-content.edition.published

Edition - published

dynamic-content.content-item.created

Content item - created

dynamic-content.content-item.updated

Content item - updated

dynamic-content.content-item.workflow.updated

Content item workflow - updated

For more information on using webhooks see https://docs.amplience.net/integration/webhooks.html

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

{
  "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"
  } ],
  "filters" : [ {
    "type" : "equal",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : "abc"
    } ]
  }, {
    "type" : "in",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : [ "abc", "def" ]
    } ]
  } ],
  "headers" : [ {
    "key" : "X-key",
    "value" : "x-value",
    "secret" : true
  } ],
  "customPayload" : {
    "type" : "payload_type",
    "value" : "payload_value"
  },
  "method" : "POST"
}

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/5e4d7a7546e0fb036387db6e/webhooks/5a497a000000000000000000
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1761

{
  "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",
  "headers" : [ {
    "key" : "X-key",
    "value" : "x-value",
    "secret" : true
  } ],
  "filters" : [ {
    "type" : "equal",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : "abc"
    } ]
  }, {
    "type" : "in",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : [ "abc", "def" ]
    } ]
  } ],
  "customPayload" : {
    "type" : "payload_type",
    "value" : "payload_value"
  },
  "method" : "POST",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6e/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/5e4d7a7446e0fb036387db68/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: 4773

{
  "_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",
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000001"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000001/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000001"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/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",
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000002"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000002/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000002"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/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",
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000003"
        },
        "hub" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68"
        },
        "requests" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000003/requests{?cursor,limit}",
          "templated" : true
        },
        "event-types" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/event-types"
        },
        "update" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000003"
        },
        "delete" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks/5a497a000000000000000003"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks?page=0&size=3&sort=createdDate,asc"
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "last" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/webhooks?page=1&size=3&sort=createdDate,asc"
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7446e0fb036387db68/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/5e4d7a7346e0fb036387db0c/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: 7928

{
  "_embedded" : {
    "requests" : [ {
      "id" : "561859fa-a496-43f4-818a-ed787a5d5d97",
      "eventId" : "4cac0437-e6d7-42ba-b58f-c52931895f21",
      "eventName" : "dynamic-content.edition.scheduled",
      "requestState" : "SUCCESS",
      "attempts" : 1,
      "request" : {
        "method" : "POST",
        "url" : "http://example.com",
        "headers" : {
          "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
          "Content-Type" : "application/json"
        },
        "customHeaders" : null,
        "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
      },
      "invocations" : [ {
        "request" : {
          "method" : "POST",
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "customHeaders" : null,
          "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "method" : "POST",
          "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" : "..."
        },
        "invocationTimestamp" : "2018-05-15T12:07:12.229Z"
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "evaluatedFilters" : null,
      "customPayload" : null,
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests/561859fa-a496-43f4-818a-ed787a5d5d97"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/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,
      "request" : {
        "method" : "POST",
        "url" : "http://example.com",
        "headers" : {
          "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
          "Content-Type" : "application/json"
        },
        "customHeaders" : null,
        "body" : "{\"sequenceId\":3,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
      },
      "invocations" : [ {
        "request" : {
          "method" : "POST",
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "customHeaders" : null,
          "body" : "{\"sequenceId\":2,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "method" : "POST",
          "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" : "..."
        },
        "invocationTimestamp" : "2018-05-15T12:07:12.229Z"
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "evaluatedFilters" : null,
      "customPayload" : null,
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests/06f89aa1-3309-4800-a546-9af5853d33fd"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/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,
      "request" : {
        "method" : "POST",
        "url" : "http://example.com",
        "headers" : {
          "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
          "Content-Type" : "application/json"
        },
        "customHeaders" : null,
        "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
      },
      "invocations" : [ {
        "request" : {
          "method" : "PATCH",
          "url" : "http://example.com",
          "headers" : {
            "X-Amplience-Hmac-Sha256" : "1VVTWEZPxOGIkTL9b5V6rEjiiP46N2yHg/pYpLmcaKA=",
            "User-Agent" : "Amplience-Webhook/0.1",
            "Content-Length" : "171",
            "Content-Type" : "application/json"
          },
          "customHeaders" : null,
          "body" : "{\"sequenceId\":1,\"eventId\":\"8e5b697d-7c32-4e30-8ddd-2601808131d9\",\"eventName\":\"dynamic-content.edition.scheduled\",\"system\":\"dynamic-content\",\"resource\":\"0001\",\"payload\":{}}"
        },
        "response" : {
          "statusCode" : 200,
          "method" : "PATCH",
          "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" : "..."
        },
        "invocationTimestamp" : "2018-05-15T12:07:12.229Z"
      } ],
      "createdTimestamp" : "2018-05-15T12:07:12.229Z",
      "scheduledTimestamp" : "2018-05-15T12:07:12.229Z",
      "evaluatedFilters" : null,
      "customPayload" : null,
      "method" : "POST",
      "_links" : {
        "self" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests/aad0db85-9af5-41e5-b761-95081e50a69d"
        },
        "request" : {
          "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests/{id}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests?limit=20"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "next" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7346e0fb036387db0c/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/5e4d7a7546e0fb036387db78/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: 1270

{
  "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",
  "headers" : [ ],
  "filters" : [ ],
  "method" : "POST",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db78/webhooks/5a497a000000000000000000"
    }
  }
}

Updating a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

PATCH /v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/5a497a000000000000000000 HTTP/1.1
Content-Type: application/json
Accept: application/hal+json
Host: api.amplience.net
Content-Length: 715

{
  "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"
  } ],
  "customPayload" : {
    "type" : "payload",
    "value" : "updated_payload"
  },
  "method" : "PATCH",
  "headers" : [ {
    "key" : "X-key",
    "value" : "x-value",
    "secret" : true
  } ],
  "filters" : [ {
    "type" : "equal",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : "abc"
    } ]
  }, {
    "type" : "in",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : [ "abc", "def" ]
    } ]
  } ]
}

Example response

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

{
  "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",
  "headers" : [ {
    "key" : "X-key",
    "value" : "x-value",
    "secret" : true
  } ],
  "filters" : [ {
    "type" : "equal",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : "abc"
    } ]
  }, {
    "type" : "in",
    "arguments" : [ {
      "jsonPath" : "$.id"
    }, {
      "value" : [ "abc", "def" ]
    } ]
  } ],
  "customPayload" : {
    "type" : "payload",
    "value" : "updated_payload"
  },
  "method" : "PATCH",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/5a497a000000000000000000"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c"
    },
    "requests" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/5a497a000000000000000000/requests{?cursor,limit}",
      "templated" : true
    },
    "event-types" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/event-types"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/5a497a000000000000000000"
    },
    "delete" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7a7546e0fb036387db6c/webhooks/5a497a000000000000000000"
    }
  }
}

Deleting a Webhook

Auth rules

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

Required ACLs:
  • Hub - READ

Example request

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

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

Listing Workflow States On a Hub

Auth rules

Required Functional Permissions:
  • none

Required ACLs:
  • Hub - READ

Example request

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

Example response

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Last-Modified: Wed, 19 Feb 2020 18:13:36 GMT
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 729

{
  "id" : "5e4d7ad046e0fb036387faf3",
  "label" : "To Do",
  "createdBy" : "user",
  "createdDate" : "2020-02-19T18:13:36.793Z",
  "lastModifiedBy" : "user",
  "lastModifiedDate" : "2020-02-19T18:13:36.793Z",
  "color" : "rgb(192,192,192)",
  "_links" : {
    "self" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5e4d7ad046e0fb036387faf3"
    },
    "workflow-state" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5e4d7ad046e0fb036387faf3"
    },
    "hub" : {
      "href" : "https://api.amplience.net/v2/content/hubs/5e4d7ad046e0fb036387faf2"
    },
    "update" : {
      "href" : "https://api.amplience.net/v2/content/workflow-states/5e4d7ad046e0fb036387faf3"
    }
  }
}

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

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

Creating a new Salesforce Commerce Cloud (SFCC) Integration

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

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

  • PLATFORM_INTEGRATION:FUNCTIONAL:SFCC:CREATE

  • CONTENT:FUNCTIONAL:WEBHOOK:CREATE

Required ACLs:
  • Hub - READ

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

Extensions

Create an Extension

Auth rules

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

Example request

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

Example response

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

Listing Extensions

Auth rules

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

Example request

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

Example response

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

Get an Extension

Auth rules

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

Example request

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

Example response

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

Get an Extension by name

Auth rules

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

Example request

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

Example response

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

Update an Extension

Auth rules

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

Example request

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

Example response

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

Delete an Extension

Auth rules

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

Example request

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

Example response

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