{ "opencollection": "1.0.0", "info": { "name": "Pure activity conferenceSeries API", "version": "5.35.3-4" }, "request": { "auth": { "type": "apikey", "key": "api-key", "value": "{{api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "conferenceSeries", "type": "folder" }, "items": [ { "info": { "name": "Lists all conference series", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series", "params": [ { "name": "size", "value": "", "type": "query", "description": "Number of returned conference series 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 /conference-series/orderings" } ] }, "docs": "Lists all conference series in the Pure instance. If you need to filter the conference series returned, see the POST version which supports additional filtering." }, { "info": { "name": "Create conference series", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/conference-series", "body": { "type": "json", "data": "{}" } }, "docs": "Create conference series" }, { "info": { "name": "A list of keyword group configurations", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/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/conference-series/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/conference-series/allowed-locales" }, "docs": "Get a list of allowed locales that can be used when submitting localized string entities." }, { "info": { "name": "A list of allowed metric collections", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/allowed-metric-collections" }, "docs": "Get a list of metric collections allowed on conference series" }, { "info": { "name": "A list of allowed classifications for the type property", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/allowed-types" }, "docs": "Get a list of classifications that can be used when submitting a type." }, { "info": { "name": "Lists available orderings", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/orderings" }, "docs": "Lists all orderings available to the conference series endpoint. These values can be used by the order parameter when listing conference series." }, { "info": { "name": "Query operation for conference series", "type": "http" }, "http": { "method": "POST", "url": "/ws/api/conference-series/search", "body": { "type": "json", "data": "{}" } }, "docs": "Lists conference series 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 conference series", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the desired conference series" } ] }, "docs": "Get conference series with specific UUID." }, { "info": { "name": "Update conference series", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/conference-series/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conference series to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update conference series with specific UUID." }, { "info": { "name": "Delete conference series", "type": "http" }, "http": { "method": "DELETE", "url": "/ws/api/conference-series/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conference series" } ] }, "docs": "Delete conference series with specific UUID." }, { "info": { "name": "Lock the content", "type": "http" }, "http": { "method": "POST", "url": "/ws/api/conference-series/: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/conference-series/: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": "Lists all dependents to the conference series", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/:uuid/dependents", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conference series" } ] }, "docs": "Lists all dependents to the conference series with the specified UUID. If the user does not have access to view all the dependent content, an authorization error will be thrown. " }, { "info": { "name": "Lists metrics with collection id", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/:uuid/metrics/:collection-id", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conference series to get metrics for" }, { "name": "collection-id", "value": "", "type": "path", "description": "ID of the metrics collection to get metrics for" } ] }, "docs": "Lists metrics from a specific metrics collection that associated with a conference series." }, { "info": { "name": "Lists notes", "type": "http" }, "http": { "method": "GET", "url": "/ws/api/conference-series/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conferenceSeries 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 conferenceSeries ordered by date (nulls last)" }, { "info": { "name": "Create note", "type": "http" }, "http": { "method": "PUT", "url": "/ws/api/conference-series/:uuid/notes", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the conferenceSeries to add note to" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create note and associate it with a conferenceSeries" } ] } ], "bundled": true }