Sign in

v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB
Collections

View a collection by ID

get/collections/view/{collectionId}

Path parameters

string required
OR
string uuid required
Example:12345

UUID or numeric ID of the collection

Response

A collection

Example response

{
  "Collection": {
    "CollectionElement": [
      {
        "id": "12345",
        "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
        "collection_id": "12345",
        "element_uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
        "description": "This is a dummy description, for a collection element."
      }
    ],
    "id": "12345",
    "org_id": "12345",
    "orgc_id": "12345",
    "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
    "created": "2024-03-19 11:10:24",
    "modified": "2024-03-19 11:10:24",
    "Org": {
      "id": "12345",
      "name": "ORGNAME",
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b"
    },
    "Orgc": {
      "id": "12345",
      "name": "ORGNAME",
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b"
    },
    "name": "APT Campaign Collection",
    "description": "This is a dummy description, for a collection about Aiur.",
    "distribution": "4",
    "sharing_group_id": "1"
  }
}