{ "opencollection": "1.0.0", "info": { "name": "Pure activity pressMedia API", "version": "5.35.1-2" }, "request": { "auth": { "type": "apikey", "key": "api-key", "value": "{{api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "pressMedia", "type": "folder" }, "items": [ { "info": { "name": "List all Press/Media content", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of returned Press/Media per request." }, { "name": "offset", "value": "", "type": "query", "description": "The offset for the returned list. 0 or null value is from the start" }, { "name": "order", "value": "", "type": "query", "description": "The order of the list, must be a value from /pressmedia/orderings" } ] }, "docs": "List all Press/Media content in the Pure instance. If you need to filter which content is returned returned, see the POST version which supports additional filtering." }, { "info": { "name": "Create Press/Media content", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/pressmedia", "body": { "type": "json", "data": "{}" } }, "docs": "Create Press/Media content in the Pure instance." }, { "info": { "name": "A list of allowed categories", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-categories" }, "docs": "Get a list of allowed categories on Press/Media content" }, { "info": { "name": "Get allowed classifications for the custom-defined field associated with the Press/Media", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-custom-defined-field-values/:fieldIdentifer/classifications", "params": [ { "name": "fieldIdentifer", "value": "", "type": "path", "description": "FieldIdentifer for the desired custom-defined field" } ] }, "docs": "Get allowed classifications for the custom-defined field associated with the Press/Media." }, { "info": { "name": "A list of allowed description types", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-descriptions-types" }, "docs": "Get a list of classifications that can be used when submitting a description." }, { "info": { "name": "A list of allowed image types", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-image-types" }, "docs": "Get a list of allowed image types that can be used for the 'images.type' attribute of activities" }, { "info": { "name": "A list of keyword group configurations", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-keyword-group-configurations" }, "docs": "Get a list of allowed keyword group configurations that can be used when submitting keyword groups." }, { "info": { "name": "A list of allowed classifications for the specified keyword group", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-keyword-group-configurations/:id/classifications", "params": [ { "name": "id", "value": "", "type": "path", "description": "Pure id of the keyword group configuration" } ] }, "docs": "Get a list of allowed classifications that can be used when submitting a specified keyword group." }, { "info": { "name": "A list of allowed locales in localized strings", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-locales" }, "docs": "Get a list of allowed locales that can be used when submitting localized string entities." }, { "info": { "name": "A list of allowed media coverage types", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverage-types" }, "docs": "Get a list of allowed types that can be used for the 'mediaCoverageType' attribute of media coverages on Press/Media" }, { "info": { "name": "A list of allowed countries", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverages-countries" }, "docs": "Get a list of allowed countries for media coverages on Press/Media" }, { "info": { "name": "A list the degrees of recognition allowed on Press/Media", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverages-degree-of-recognitions" }, "docs": "Get a list of degrees of recognition that are allowed to be used for the attribute 'mediaCoverage.degreeOfRecognition' on Press/Media." }, { "info": { "name": "A list of allowed media types", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverages-media-types" }, "docs": "Get a list of allowed types that can be used for the 'mediaType' attribute of media coverages on Press/Media" }, { "info": { "name": "A list of allowed person roles", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverages-persons-roles" }, "docs": "Get a list of allowed person roles that can be used for the 'persons.role' attribute of the Press/Media media coverage." }, { "info": { "name": "A list of allowed subdivisions", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-media-coverages-subdivisions" }, "docs": "Get a list of allowed subdivisions for media coverages on Press/Media" }, { "info": { "name": "A list of allowed Press/Media types", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-types" }, "docs": "Get a list of allowed types that can be used for the 'type' attribute of Press/Media" }, { "info": { "name": "A list of allowed workflow steps", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/allowed-workflow-steps" }, "docs": "Get a list of allowed workflow steps that can be used for the 'workflow' attribute of Press/Media content" }, { "info": { "name": "Upload file to a specific Press/Media", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/pressmedia/file-uploads", "headers": [ { "name": "Content-Type", "value": "" } ] }, "docs": "Uploads file for the Press/Media with the specified UUID." }, { "info": { "name": "Lists available orderings", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/orderings" }, "docs": "Lists all orderings available to the Press/Media endpoint. These values can be used by the order parameter." }, { "info": { "name": "Query operation for Press/Media content", "type": "http" }, "http": { "method": "POST", "url": "/ws/api/pressmedia/search", "body": { "type": "json", "data": "{}" } }, "docs": "Lists Press/Media content in the Pure instance that matches the provided query. similar to the GET version, instead of using parameters to alter the response, an JSON document is posted with the request. The JSON document contains fields for all the parameters available for the GET version, but also additional filtering options." }, { "info": { "name": "Get specific Press/Media", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired Press/Media" } ] }, "docs": "Get Press/Media with specific UUID." }, { "info": { "name": "Update Press/Media", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/pressmedia/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the Press/Media to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Press/Media with specific UUID." }, { "info": { "name": "Delete specific Press/Media", "type": "http" }, "http": { "method": "DELETE", "url": "/ws/api/pressmedia/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the Press/Media" } ] }, "docs": "Delete Press/Media content with specific UUID." }, { "info": { "name": "Lock the content", "type": "http" }, "http": { "method": "POST", "url": "/ws/api/pressmedia/:uuid/actions/lock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the content to lock" } ] }, "docs": "Mark the content as external (used when content contains synchronised data). This has no effect on interactions with the content through the API." }, { "info": { "name": "Unlock the content", "type": "http" }, "http": { "method": "POST", "url": "/ws/api/pressmedia/:uuid/actions/unlock", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the content to unlock" } ] }, "docs": "Remove the external mark on the content (used when content contains synchronised data). This has no effect on interactions with the content through the API." }, { "info": { "name": "Get file related to Press/Media", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/:uuid/files/:fileId", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the Press/Media" }, { "name": "fileId", "value": "", "type": "path", "description": "File id " } ] }, "docs": "Get file related to Press/Media" }, { "info": { "name": "Lists notes", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/pressmedia/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the Press/Media to get notes for" }, { "name": "size", "value": "", "type": "query", "description": "Number of returned notes per request" }, { "name": "offset", "value": "", "type": "query", "description": "The offset for the returned list. 0 or null value is from the start" } ] }, "docs": "Lists notes associated with a specific Press/Media ordered by date (nulls last)" }, { "info": { "name": "Create note", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/pressmedia/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the Press/Media to add note to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create note and associate it with a piece of Press/Media" } ] } ], "bundled": true }