{ "info": { "_postman_id": "8b1748f7-e41d-4abc-9bcb-5cbecb10c758", "name": "SPORIFY v1.0", "description": "This collection contains a wide variety of examples of how to use the API of SPORIFY. It focuses on the management of Source lists and Target data for SPOR. In the Howto section, the usual business processes of how to synchronise data with SPORIFY and individual source systems are explained.\n\nTo use this collection and each request definition, please consider filling in all the variables defined in the table below:\n\n| **Variable** | **Description** |\n| --- | --- |\n| baseURL | Root URL for the instance to communicate. For both available environments there are two different values:

**Validation**: [https://v.sporify.eu](https://v.sporify.eu)

**Production**: [https://sporify.eu](https://sporify.eu) |\n| authorization | Authorization token to be used for authorization requests. |\n| tenancyName | Name of the tenant the user account is assigned to. |\n| usernameOrEmailAddress | Username or email address of a user account. |\n| password | Password of the user account. |\n| omssourcelistid | OMS Source List ID. Unique identification number of a source list uploaded to Organisations. |\n| omssourcelistelementid | OMS Source List element ID. Unique identification number of an element in a source list for Organisations. |\n| systemid | System ID. Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| resolutionstatusid | Resolution Status ID. Unique identification number of a resolution status object. Please refer to Resolution Status in the Administration section of SPORIFY. |\n| datagovernancestatusid | Data Governance Status ID. Unique identification number of a data governance status object. Please refer to Data Governance in the Administration section of SPORIFY. |\n| smssourcelistid | SMS Source List ID. Unique identification number of a source list uploaded to Substances. |\n| smssourcelistelementid | SMS Source List Element ID. Unique identification number of an element in a source list for Substances. |\n| rmssourcelistid | RMS Source List ID. Unique identification number of a source list uploaded to Referentials. |\n| rmssourcelistelementid | RMS Source List Element ID. Unique identification number of an element in a source list for Referentials. |", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25217109" }, "item": [ { "name": "Authentication", "item": [ { "name": "User Name and Password", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"tenancyName\": \"{{tenancyName}}\",\r\n \"usernameOrEmailAddress\": \"{{usernameOrEmailAddress}}\",\r\n \"password\": \"{{password}}\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/Account", "host": [ "{{baseUrl}}" ], "path": [ "api", "Account" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- tenancyName\n- usernameOrEmailAddress\n- password\n \n\nTo authenticate a user account in SPORIFY, please supply tenant name (tenancyName), username or email address (usernameOrEmailAddress) and password (password).\n\nWhen an authentication request is successful, the following json will be responded by the server:\n\n```\n \"result\": \"Bio2ATGdTrQCNuk9kVO9...\",\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}\n\n```\n\nThe string value within the attribute **result** is the identification for the recently established session. Any further requests must have the token in the header section as a bearer token.\n\nNote that the string “Bearer” should prefix the received token value in the _Authorization_ header, e.g. “Bearer Bio2ATGdTrQCNuk9kVO9...”. Issued tokens will be valid for **24 hours** after which time the authentication process should be repeated.\n\nUse the variable authentication of this collection to use the established session for any further request.\n\nPlease find further information in [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-Authentication)." }, "response": [] } ], "description": "SPORIFY needs an authenticated session for every request. In this folder, the required actions are described to perform an authentication request and the retrieval of the so-called bearer token to be used in every other request to SPORIFY." }, { "name": "Substances", "item": [ { "name": "Source Lists", "item": [ { "name": "Retrieve All Lists", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "systemId", "value": "", "description": "ID of the system the lists got assigned to", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "name", "value": "", "description": "Search string for sourcelists name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetSubstances)." }, "response": [] }, { "name": "Retrieve List by Name", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists?name=AAAAABBB", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists" ], "query": [ { "key": "name", "value": "AAAAABBB" } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists with a specific name." }, "response": [] }, { "name": "Retrieve List Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists/{{smssourcelistid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists", "{{smssourcelistid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- smssourcelistid\n \n\nThis endpoint provides the full details of specific source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetSubstancebyID)." }, "response": [] }, { "name": "Retrieve List Elements", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists/{{smssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists", "{{smssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- smssourcelistid\n \n\nThis endpoint provides the elements of a specific source list." }, "response": [] }, { "name": "Retrieve List Elements Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists/{{smssourcelistid}}/elements/{{smssourcelistelementid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists", "{{smssourcelistid}}", "elements", "{{smssourcelistelementid}}" ] }, "description": "As a prerequisite of using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- smssourcelistid\n- smssourcelistelementid\n \n\nThis endpoint provides the details of a particular element of specific source lists." }, "response": [] }, { "name": "Create List", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"systemId\": \"{{systemid}}\",\r\n \"name\": \"api created source list\",\r\n \"language\": \"EN\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- systemid\n \n\nThis endpoint provides the functionality to create a source list.\n\nTo create a source list for Substances, supply the following data.\n\n| **Name** | **Description** |\n| --- | --- |\n| systemId | Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| name | Name of the source list. |\n| language | An ISO 639-1 two-letter code specifying the language. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSubstanceSourceList)." }, "response": [] }, { "name": "Create List Element", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"sourceId\": \"12345\",\r\n \"name\": \"aspirin\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/substances/lists/{{smssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "substances", "lists", "{{smssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- smssourcelistid\n \n\nThis endpoint provides the functionality to create an element in a specific source list.\n\nTo create a source list for Organisations, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| systemId | Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| name | Name of the source list. |\n\nStartFragment\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSourceSubstance).\n\nEndFragment" }, "response": [] } ], "description": "In this folder, the usage for Substances Source List endpoints is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-SourceLists(Mapping).2) for further details on Substances Source Lists." }, { "name": "Target Substances", "item": [ { "name": "Retrieve All Substances", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/sms/substances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "sms", "substances" ], "query": [ { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "domain", "value": "", "description": "Substance belongs to this domain. Must be one of: “Human use”, “Veterinary use”", "disabled": true }, { "key": "status", "value": "", "description": "Substance has this status. Must be one of: Active, Inactive, Provisional.", "disabled": true }, { "key": "tags", "value": "", "description": "Substance has been tagged with any of these values", "disabled": true }, { "key": "dataGovernanceStage", "value": "", "description": "Organisation must be in this data governance stage (1, 2 or 3", "disabled": true }, { "key": "dataGovernanceStatus", "value": "", "description": "Organisation must have a data governance status with this name", "disabled": true }, { "key": "name", "value": "", "description": "search string for name of organisations", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available substances in SPOR SMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetSubstances)." }, "response": [] }, { "name": "Retrieve Substance Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/sms/substances/100000075987", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "sms", "substances", "100000075987" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the details of specific substances in SPOR SMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetSubstancebyID)." }, "response": [] } ], "description": "In this folder, the usage for SPOR Substances Target Data endpoints is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-TargetSubstances(BrowseTargetSubstanceLists)) for further details on Substances Target Data." } ], "description": "In this folder, the usages for SPOR Substances Source Lists and Target Data endpoints are described.\n\nFor all request examples in this folder, the following request parameters are possible to use:\n\n| Name | Description | Default
|\n| --- | --- | --- |\n| **page**
| The page to return.
| 1
|\n| **pageSize** | The number of items to include in the paged result. Must be between 1 and 100. | 20 |\n| **sortBy** | The field by which the resource is sorted. Default **sortBy**s are resource specific. | |\n| **sortOrder** | Used with **sortBy** to apply sorting. Must be one of: “asc”, “desc”. | “asc”

|" }, { "name": "Organisations", "item": [ { "name": "Source Lists", "item": [ { "name": "Retrieve All Lists", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "systemId", "value": "", "description": "ID of the system the lists got assigned to", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "name", "value": "", "description": "Search string for sourcelists name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationSourceLists)." }, "response": [] }, { "name": "Retrieve List by Name", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists?name=AAAAABBB", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists" ], "query": [ { "key": "name", "value": "AAAAABBB" } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists with a specific name." }, "response": [] }, { "name": "Retrieve List Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/{{omssourcelistid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "{{omssourcelistid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- omssourcelistid\n \n\nThis endpoint provides the full details of specific source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationbyID)." }, "response": [] }, { "name": "Retrieve List Elements", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/{{omssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "{{omssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- omssourcelistid\n \n\nThis endpoint provides the elements of a specific source list." }, "response": [] }, { "name": "Retrieve List Elements Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/{{omssourcelistid}}/elements/{{omssourcelistelementid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "{{omssourcelistid}}", "elements", "{{omssourcelistelementid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- omssourcelistid\n- omssourcelistelementid\n \n\nThis endpoint provides the details of a particular element of a specific source list." }, "response": [] }, { "name": "Create List", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"systemId\": \"{{systemid}}\",\r\n \"name\": \"api created source list\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the functionality to create a source list.\n\nTo create a source list for Organisations, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| systemId | Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| name | Name of the source list. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSubstanceSourceList)." }, "response": [] }, { "name": "Create List Element", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"sourceId\": \"123456789\",\r\n \"name\": \"string\",\r\n \"address\": \"string\",\r\n \"comment\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/{{omssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "{{omssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- omssourcelistid\n \n\nThis endpoint provides the functionality to create an element in a specific source list.\n\nTo create a source list for Organisations, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| sourceId | The primary key of this term in your Source System. |\n| name | The organisation’s name. |\n| address | The organisation’s address. |\n| comment | A comment regarding this organisation. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSourceOrganisation)." }, "response": [] } ], "description": "In this folder, the usage for Organisation Source Lists is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-SourceLists(Mapping).1) for further details on Organisation Source Lists." }, { "name": "Target Organisations", "item": [ { "name": "Retrieve All Organisations", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/organisations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "organisations" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "status", "value": "", "description": "Organisation has this status. Must be one of: Active, Inactive, Provisional.", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "favouritesOnly", "value": "", "description": "Restrict Organisations to those that have been favourited", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "dataGovernanceStage", "value": "", "description": "Organisation must be in this data governance stage (1, 2 or 3", "disabled": true }, { "key": "dataGovernanceStatus", "value": "", "description": "Organisation must have a data governance status with this name", "disabled": true }, { "key": "name", "value": "", "description": "search string for name of organisations", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Organisations in SPOR OMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-SPOROMS)." }, "response": [] }, { "name": "Retrieve Organisation Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/organisations/ORG-100000000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "organisations", "ORG-100000000" ], "query": [ { "key": "normalise", "value": null, "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the details of specific Organisations in SPOR OMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationbyID)." }, "response": [] }, { "name": "Retrieve All Locations", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/organisations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "organisations" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "address", "value": "", "description": "Location’s address contains this value", "disabled": true }, { "key": "orgId", "value": null, "description": "ID of the organisation locations are associated with", "disabled": true }, { "key": "status", "value": null, "description": "Location has this status. Must be one of: Active, Inactive, Provisional", "disabled": true }, { "key": "tags", "value": null, "description": "Location has been tagged with any of these values", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "favouritesOnly", "value": "", "description": "Restrict Organisations to those that have been favourited", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Locations in SPOR OMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetLocations)." }, "response": [] }, { "name": "Retrieve Location Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/locations/LOC-100002413", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "locations", "LOC-100002413" ], "query": [ { "key": "normalise", "value": null, "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the details of specific Locations in SPOR OMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetLocationbyID)." }, "response": [] } ], "description": "In this folder, the usage for SPOR Organisation Target Data endpoints is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-TargetOrganisations(BrowseTargetOrganisationsandLocations)) for further details on Organisation Target Data." } ], "description": "In this folder, the usage for SPOR Organisation Source Lists and Target Data endpoints is described.\n\nFor all request examples in this folder, the following request parameters are possible to use:\n\n| Name | Description | Default
|\n| --- | --- | --- |\n| **page**
| The page to return.
| 1
|\n| **pageSize** | The number of items to include in the paged result. Must be between 1 and 100. | 20 |\n| **sortBy** | The field by which the resource is sorted. Default **sortBy**s are resource specific. | |\n| **sortOrder** | Used with **sortBy** to apply sorting. Must be one of: “asc”, “desc”. | “asc”

|" }, { "name": "Referentials", "item": [ { "name": "Source Lists", "item": [ { "name": "Retrieve All Lists", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "systemId", "value": "", "description": "ID of the system the lists got assigned to", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "name", "value": "", "description": "Search string for sourcelists name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetReferentialSourceLists)." }, "response": [] }, { "name": "Retrieve List by Name", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists?name=AAAAABBB", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists" ], "query": [ { "key": "name", "value": "AAAAABBB" } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available source lists with a specific name." }, "response": [] }, { "name": "Retrieve List Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists/{{rmssourcelistid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists", "{{rmssourcelistid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- rmssourcelistid\n \n\nThis endpoint provides the full details of specific source lists uploaded to SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationbyID)." }, "response": [] }, { "name": "Retrieve List Elements", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists/{{rmssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists", "{{rmssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- rmssourcelistid\n \n\nThis endpoint provides the elements of a specific source list." }, "response": [] }, { "name": "Retrieve List Elements Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists/{{rmssourcelistid}}/elements/{{rmssourcelistelementid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists", "{{rmssourcelistid}}", "elements", "{{rmssourcelistelementid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- rmssourcelistid\n- rmssourcelistelementid\n \n\nThis endpoint provides the details of a particular element of a specific source list." }, "response": [] }, { "name": "Create List", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"systemId\": \"{{systemid}}\",\r\n \"name\": \"countries\",\r\n \"rmsListId\": 100000000002,\r\n \"language\": \"en\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists/", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists", "" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the functionality to create a source list.\n\nTo create a source list for Referentials, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| systemId | Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| name | Name of the source list. |\n| rmsListId | The list ID of the Target RMS List. |\n| language | An ISO 639-1 two-letter code specifying the language. |\n\nPlease find futher information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateReferentialSourceList)." }, "response": [] }, { "name": "Create List Element", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"sourceId\": \"123456789\",\r\n \"name\": \"string\",\r\n \"shortName\": \"string\",\r\n \"otherName\": \"string\",\r\n \"description\": \"string\",\r\n \"comment\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/referentials/lists/{{rmssourcelistid}}/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "referentials", "lists", "{{rmssourcelistid}}", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- rmssourcelistid\n \n\nThis endpoint provides the functionality to create an element in a specific source list.\n\nTo create a source list for Referentials, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| sourceId | The primary key of this Term in your Source System. |\n| name | Name of the term. |\n| shortName | Term’s short name. |\n| otherName | Term’s other name. |\n| description | Term’s description. |\n| comment | Comment regarding this term. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSourceTerm)." }, "response": [] } ], "description": "In this folder the usage for Referentials Source Lists is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-SourceLists(Mapping)) for further details on Referentials Source Lists." }, { "name": "Target Referentials", "item": [ { "name": "Retrieve All Refrentials Lists", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/rms/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "rms", "lists" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "tags", "value": null, "description": "Referentials List has been tagged with any of these values", "disabled": true }, { "key": "favouritesOnly", "value": "", "description": "Restrict Organisations to those that have been favourited", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "dataGovernanceStage", "value": "", "description": "Organisation must be in this data governance stage (1, 2 or 3", "disabled": true }, { "key": "dataGovernanceStatus", "value": "", "description": "Organisation must have a data governance status with this name", "disabled": true }, { "key": "name", "value": "", "description": "search string for name of organisations", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Referentials lists in SPOR RMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-SPOROMS)." }, "response": [] }, { "name": "Retrieve Referentials List Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/rms/lists/100000000001", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "rms", "lists", "100000000001" ], "query": [ { "key": "normalise", "value": null, "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the details of specific Referentials lists in SPOR RMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationbyID)." }, "response": [] }, { "name": "Retrieve All Refrentials Terms", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/rms/terms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "rms", "terms" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "domain", "value": null, "description": "Term’s domain is in this comma-separated list of domains. Domains can be specified by Term ID or short name", "disabled": true }, { "key": "status", "value": "", "description": "Must be one of: CURRENT, NON_CURRENT, PROVISIONAL", "disabled": true }, { "key": "tags", "value": "", "description": "Term has been tagged with any of these values", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "dataGovernanceStage", "value": null, "description": "Term must be in this data governance stage (1, 2 or 3)", "disabled": true }, { "key": "dataGovernanceStatus", "value": null, "description": "Term must have a data governance status with this name", "disabled": true }, { "key": "name", "value": null, "description": "Term name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Referentials terms in SPOR RMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetTerms)." }, "response": [] }, { "name": "Retrieve Referentials Term Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/rms/terms/100000000012", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "rms", "terms", "100000000012" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the details of specific Referentials terms in SPOR RMS.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetTermbyTermID)." }, "response": [] } ], "description": "In this folder, the usage for SPOR Referentials Target Data endpoints is described.\n\nPlease see the [User Guide](https://docs.sporify.eu/guides/latest/user-guide#id-(22.4)UserGuide-TargetLists(TermView)) for further details on Referentials Target Data." } ], "description": "In this folder, the usage for SPOR Referentials Source Lists and Target Data endpoints is described.\n\nFor all request examples in this folder, the following request parameters are possible to use:\n\n| Name | Description | Default
|\n| --- | --- | --- |\n| **page**
| The page to return.
| 1
|\n| **pageSize** | The number of items to include in the paged result. Must be between 1 and 100. | 20 |\n| **sortBy** | The field by which the resource is sorted. Default **sortBy**s are resource specific. | |\n| **sortOrder** | Used with **sortBy** to apply sorting. Must be one of: “asc”, “desc”. | “asc”

|" }, { "name": "Administration", "item": [ { "name": "Manage Systems", "item": [ { "name": "Retrieve All Systems", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/systems", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "systems" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "name", "value": "", "description": "Search string for system name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available systems configured in SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-SourceSystems)." }, "response": [] }, { "name": "Retrieve System Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/systems/{{systemid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "systems", "{{systemid}}" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "name", "value": "", "description": "Search string for system name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- systemid\n \n\nThis endpoint provides the details of a specific system.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetSourceSystembyID)." }, "response": [] } ], "description": "In this folder the usage for manage systems endpoints is described.\n\nPlease see [Administrator Guide](https://docs.sporify.eu/guides/latest/administrator-guide#id-(22.4)AdministratorGuide-ManageSystems) for further details on manage systems." }, { "name": "Resolution Status", "item": [ { "name": "Retrieve All Resolution Statuses", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/resolution-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "resolution-status" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "name", "value": "", "description": "Search string for resolution status name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Resolution Statuses configured in SPORIFY.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetResolutionStatus)." }, "response": [] }, { "name": "Retrieve Resolution Status Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/resolution-status/{{resolutionstatusid}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "resolution-status", "{{resolutionstatusid}}" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n- resolustionstatusid\n \n\nThis endpoint provides the details of a specific Resolution Status.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetResolutionStatusbyID)." }, "response": [] } ], "description": "Please see the [Administrator Guide](https://docs.sporify.eu/guides/latest/administrator-guide#id-(22.4)AdministratorGuide-ResolutionStatus) for further details on Resolution Statuses." }, { "name": "Data Governance", "item": [ { "name": "Governance Status", "item": [ { "name": "Retrieve All Statuses", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/datagovernance-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "datagovernance-status" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "name", "value": "", "description": "Search string for resolution status name", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nThis endpoint provides the list of all available Data Governance Statuses." }, "response": [] } ], "description": "In this folder, the usage for Data Governance Statuses endpoints is described." } ], "description": "Please see the [Administrator Guide](https://docs.sporify.eu/guides/latest/administrator-guide#id-(22.4)AdministratorGuide-DataGovernance) for further details on Data Governance." } ], "description": "In this folder, the usage for Administration endpoints is described.\n\nPlease see the [Administrator Guide](https://docs.sporify.eu/guides/latest/administrator-guide) for further details on Administration in SPORIFY." }, { "name": "Howtos", "item": [ { "name": "Map and synchronize via source lists", "item": [ { "name": "Organisations", "item": [ { "name": "Create Source List", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"systemId\": \"{{systemid}}\",\r\n \"name\": \"OMS Source List via Rest Api\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nTo create a source list for Organisations, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| systemId | Unique identification number of a system object. Please refer to Manage Systems in the Administration section of SPORIFY. |\n| name | Name of the source list. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSubstanceSourceList).\n\nWhen the creation is successfully performed, the API response looks like this:\n\n```\n{\n \"id\": \"c5c5c1a9-3ae7-7489-75ae-6e3cdde4fb6d\",\n \"name\": \"OMS Source List via Rest Api\",\n \"organisationCount\": 0,\n \"organisationsUrl\": \"https://sporify.eu/api/v1/source/organisations/lists/c5c5c1a9-3ae7-7489-75ae-6e3cdde4fb6d/elements\",\n \"createdOn\": \"2023-01-10T07:32:56.7757067Z\",\n \"modifiedOn\": null,\n \"systemId\": \"c5c5c59f-1351-3c68-7313-b83a4b52363d\"\n}\n\n```\n\nFrom the response, the **id** (c5c5c1a9-3ae7-7489-75ae-6e3cdde4fb6d) of the source list object adds the Organisation from the individual source system." }, "response": [] }, { "name": "Add Organisations", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"sourceId\": \"1327995\",\r\n \"name\": \"AbbVie Ltd\",\r\n \"address\": \"AbbVie House Vanwall Business Park Egham Surrey TW20 8RB United Kingdom\",\r\n \"comment\": \"string\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/c5c5c1b5-1b9b-74c0-c176-603c49152b62/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "c5c5c1b5-1b9b-74c0-c176-603c49152b62", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nTo add an Organisation to the recently created source list, please supply the ID of the source list in the URL segment. Please note that it´s needed to supply one organisation per call.\n\nTo create a source list for Organisations, supply the following data:\n\n| **Name** | **Description** |\n| --- | --- |\n| sourceId | The primary key of this term in your Source System |\n| name | The organisation’s name |\n| address | The organisation’s address |\n| comment | A comment regarding this organisation |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-CreateSourceOrganisation).\n\nWhen the adding of the organisation is successfully performed, the API response looks like this:\n\n```\n{\n \"id\": \"c5d0057a-defa-f545-7ada-03277a60e26e\",\n \"sourceId\": \"1327995\",\n \"name\": \"AbbVie Ltd\",\n \"address\": \"AbbVie House Vanwall Business Park Egham Surrey TW20 8RB United Kingdom\",\n \"comment\": \"string\",\n \"status\": null,\n \"tags\": [],\n \"omsOrganisation\": null,\n \"omsLocation\": null,\n \"createdOn\": \"2023-01-10T07:42:06.1913506Z\",\n \"modifiedOn\": null\n}\n\n```" }, "response": [] }, { "name": "Perform Mapping", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/c5c5c1b5-1b9b-74c0-c176-603c49152b62/map", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "c5c5c1b5-1b9b-74c0-c176-603c49152b62", "map" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nAfter the addition of all relevant Organisations, a mapping process can be executed to link the given Organisations to SPOR and the reference Locations.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-MapOrganisationSourceList).\n\nWhen the mapping process is successfully performed, then SPORIFY responds the HTTP Status code 200.\n\nIf no mapping was found by SPORIFY, users can log on choose from a prompted list of suggestions." }, "response": [] }, { "name": "Query mapped records", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/source/organisations/lists/c5c5c1b5-1b9b-74c0-c176-603c49152b62/elements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "source", "organisations", "lists", "c5c5c1b5-1b9b-74c0-c176-603c49152b62", "elements" ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nAfter the mapping succeeds automatically or with users' support, the result can be requested by retrieving all elements of the source list.\n\nIt´s recommended to use filter options to retrieve Organisations where the mapping process was successfully finished.\n\n| **Option** | **Description** |\n| --- | --- |\n| resolutionStatusId | When using the Resolution Status to identify mapped records, the ID of the specific resolution status can be supplied in the query. Please see the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-ResolutionStatus) to retrieve the available Resolution Statuses from SPORIFY. |\n| dataGovernanceStage | When using the Data Governance feature to identify mapped records, the ID of the data governance stage can be supplied in the query. Per default there are three stages available:
1 - Pending Review
2 - Approved
3 - Accept |\n| dataGovernanceStatus | In correlation with the data governance stage, the Governance Status might need to be involved in the query. Please see the examples in the Administration section of this collection to retrieve all Data Governance Statuses. |\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetOrganisationSourceListbyID).\n\nHere is the example of the response when requesting mapped records:\n\n```\n{\n \"total\": 1,\n \"hasMore\": false,\n \"currentPage\": \"https://demo.sporify.eu/api/v1/source/organisations/lists/c5c5c1a9-3ae7-7489-75ae-6e3cdde4fb6d/elements\",\n \"nextPage\": null,\n \"items\": [\n {\n \"id\": \"c5d0057a-defa-f545-7ada-03277a60e26e\",\n \"sourceId\": \"1327995\",\n \"name\": \"AbbVie Ltd\",\n \"address\": \"AbbVie House Vanwall Business Park Egham Surrey TW20 8RB United Kingdom\",\n \"comment\": \"string\",\n \"status\": {\n \"id\": \"c5c5c5c4-aa58-3a19-6ce6-383a7c921d3a\",\n \"name\": \"Organisations Matched\"\n },\n \"tags\": [],\n \"omsOrganisation\": {\n \"organisation\": {\n \"schema-version\": \"2.0\",\n \"query-timestamp\": \"2022-07-27T07:22:16.334\",\n \"query-link\": \"https://spor.ema.europa.eu/v1/organisations\",\n \"operational-attributes\": {\n \"created-on\": \"2016-10-19T10:21:21.025+02:00\",\n \"modified-on\": \"2022-07-26T09:02:23.074+02:00\"\n },\n \"organisation-id\": {\n \"id\": \"ORG-100002472\",\n \"link\": {\n \"rel\": \"self\",\n \"href\": \"https://spor.ema.europa.eu/v1/organisations/ORG-100002472\"\n }\n },\n \"active-request\": \"false\",\n \"identifiers\": {\n \"identifier\": [\n {\n \"code-system\": \"100000167446\",\n \"code-system-name\": \"OMS Organisation Identifier\",\n \"code\": \"ORG-100006905\"\n },\n {\n \"code-system\": \"100000167446\",\n \"code-system-name\": \"OMS Organisation Identifier\",\n \"code\": \"ORG-100002472\"\n }\n ]\n },\n \"mappings\": {\n \"mapping\": {\n \"code-system\": \"100000167429\",\n \"code-system-name\": \"European Inspections Database\",\n \"code\": \"19965\"\n }\n },\n \"category-classifications\": {\n \"category-classification\": [\n {\n \"category-type\": {\n \"code-system\": \"RMS_ID\",\n \"code-system-name\": \"Lkp Party Category Type\",\n \"code\": \"200000000073\",\n \"display-name\": \"Type\"\n },\n \"category\": {\n \"code-system\": \"RMS_ID\",\n \"code-system-name\": \"Type\",\n \"code\": \"200000000080\",\n \"display-name\": \"Industry\"\n },\n \"valid-from\": \"2017-06-16T08:47:55+02:00\"\n },\n {\n \"category-type\": {\n \"code-system\": \"RMS_ID\",\n \"code-system-name\": \"Lkp Party Category Type\",\n \"code\": \"200000000073\",\n \"display-name\": \"Type\"\n },\n \"category\": {\n \"code-system\": \"RMS_ID\",\n \"code-system-name\": \"Type\",\n \"code\": \"200000000081\",\n \"display-name\": \"Pharmaceutical company\"\n },\n \"valid-from\": \"2017-06-16T08:47:55+02:00\"\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"name\": \"Abbvie Limited\",\n \"locations\": {\n \"location\": [\n {\n \"location-id\": {\n \"id\": \"LOC-100008378\",\n \"link\": {\n \"href\": \"https://spor.ema.europa.eu/v1/locations/LOC-100008378\"\n }\n }\n },\n {\n \"location-id\": {\n \"id\": \"LOC-100012300\",\n \"link\": {\n \"href\": \"https://spor.ema.europa.eu/v1/locations/LOC-100012300\"\n }\n }\n },\n {\n \"location-id\": {\n \"id\": \"LOC-100000846\",\n \"link\": {\n \"href\": \"https://spor.ema.europa.eu/v1/locations/LOC-100000846\"\n }\n }\n },\n {\n \"location-id\": {\n \"id\": \"LOC-100009768\",\n \"link\": {\n \"href\": \"https://spor.ema.europa.eu/v1/locations/LOC-100009768\"\n }\n }\n }\n ]\n },\n \"version-timestamp\": \"2022-07-26T09:02:23.074+02:00\"\n }\n },\n \"omsLocation\": null,\n \"createdOn\": \"2023-01-10T07:42:06.19Z\",\n \"modifiedOn\": \"2023-01-10T07:58:05.91Z\"\n }\n ]\n}\n\n```\n\nTo accomplish the update of the referenced record in the individual source system, please refer to the **sourceId** attribute in the response." }, "response": [] } ], "description": "In this folder, a pattern to synchronise Organisation data with a individual source system is explained. Depending on the business process to match the data, it´s recommended to agree on the resolution status to identify final mapped records. In addtion, when the data governance feature is used in SPORIFY, it´s recommended to agree on the particular data governance status to identify final mapped records.\n\nSynchronising in a nutshell:\n\n- Create a source list\n- Add Organisations / Locations to the list\n- Perform mapping\n- Extend manual mapping where needed via the front end of SPORIFY\n- Query the mapped records to write updates into the individual source system" } ], "description": "In this folder, the synchronisation of source lists with individual source systems is explained." }, { "name": "Synchronize Target Data", "item": [ { "name": "Organisations", "item": [ { "name": "Initial Synchronization", "item": [ { "name": "Retrieve All Organisations", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/organisations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "organisations" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "status", "value": "", "description": "Organisation has this status. Must be one of: Active, Inactive, Provisional.", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "favouritesOnly", "value": "", "description": "Restrict Organisations to those that have been favourited", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "dataGovernanceStage", "value": "", "description": "Organisation must be in this data governance stage (1, 2 or 3", "disabled": true }, { "key": "dataGovernanceStatus", "value": "", "description": "Organisation must have a data governance status with this name", "disabled": true }, { "key": "name", "value": "", "description": "search string for name of organisations", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to use this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nDepending on the business process, it´s recommended to use filter options to retrieve Organisations to only incorporate records of interest into the scope.\n\n| **Option** | **Description** |\n| --- | --- |\n| status | Organisation has this status. Must be one of: Active, Inactive, Provisional. |\n| favouritesOnly | Restrict Organisations to those that have been favourited. |\n| dataGovernanceStage | When using the Data Governance feature to identify approved records, the ID of the data governance stage can be supplied in the query. Per default there are three stages available:
1 - Pending Review
2 - Approved
3 - Accept |\n| dataGovernanceStatus | In correlation with the data governance stage, the Governance Status might need to be involved in the query. Please see the examples in the Administration section of this collection to retrieve all Data Governance Statuses. |\n\nIn addition, it´s recommended to use the page attribute to split the result into individual chunks. In the beginning of each response, there are indicators to help with the navigation.\n\n```\n\"total\": 43153,\n\"hasMore\": true,\n\"currentPage\": \"https://demo.sporify.eu/api/v1/spor/oms/organisations\",\n\"nextPage\": \"https://demo.sporify.eu/api/v1/spor/oms/organisations?page=2\",\n\n```\n\n| **Option** | **Description** |\n| --- | --- |\n| hasMore | **True** or **False**. When True, unread pages of the result set are available for querying. |\n| nextPage | Full qualified link to the next chunk of the result set. |\n\nEach Organisation contains a reference to multiple possible Locations:\n\n```\n\"status\": \"ACTIVE\",\n \"name\": \"Avitaris Sp. z o.o.\",\n \"locations\": {\n \"location\": {\n \"location-id\": {\n \"id\": \"LOC-100002413\",\n \"link\": {\n \"href\": \"https://spor.ema.europa.eu/v1/locations/LOC-100002413\"\n }\n }\n }\n }\n\n```\n\nTo retrieve further information about the referenced Location, please see the Retrieve Location Details query.\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-SPOROMS)." }, "response": [] }, { "name": "Retrieve Location Details", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/locations/LOC-100002413", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "locations", "LOC-100002413" ], "query": [ { "key": "normalise", "value": null, "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nTo retrieve further information about individual Locations, this query can be used to retrieve the full details. Please refer to the location-id inside the Organisation object (e.g. LOC-100002413).\n\nPlease find further information in the [API Guide](https://docs.sporify.eu/guides/latest/api-guide#id-(22.4)APIGuide-GetLocationbyID)." }, "response": [] } ], "description": "As part of a continuous synchronisation of SPOR OMS records, it´s recommended to perform an initial synchronisation to establish the relation between the source system and OMS." }, { "name": "Delta Synchronization", "item": [ { "name": "Retrieve Modified Organisations", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{authorization}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/spor/oms/organisations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "spor", "oms", "organisations" ], "query": [ { "key": "sortBy", "value": "", "description": "The field by which the resource is sorted. Default sortBys are resource specific.", "disabled": true }, { "key": "status", "value": "", "description": "Organisation has this status. Must be one of: Active, Inactive, Provisional.", "disabled": true }, { "key": "modifiedAfter", "value": "2022-11-12 08:00:00", "description": "Date of the last modification. Please use UTC time stamps like 2022-11-12 or 2022-11-12 08:00:00 including date and time", "disabled": true }, { "key": "favouritesOnly", "value": "", "description": "Restrict Organisations to those that have been favourited", "disabled": true }, { "key": "normalise", "value": "", "description": "Fix known issues with returned EMA SPOR JSON", "disabled": true }, { "key": "dataGovernanceStage", "value": "", "description": "Organisation must be in this data governance stage (1, 2 or 3", "disabled": true }, { "key": "dataGovernanceStatus", "value": "", "description": "Organisation must have a data governance status with this name", "disabled": true }, { "key": "name", "value": "", "description": "search string for name of organisations", "disabled": true }, { "key": "page", "value": "", "description": "The page to return", "disabled": true }, { "key": "pageSize", "value": "20", "description": "The number of items to include in the paged result. Must be between 1 and 100", "disabled": true }, { "key": "sortOrder", "value": "asc", "description": "Used with sortBy to apply sorting. Must be one of: “asc”, “desc”.", "disabled": true } ] }, "description": "As a prerequisite to using this query, please fill in the following variables in the root folder of this collection:\n\n- baseUrl\n \n\nWhen an intial synchronisation is successfully performed, from that time on it´s recommended to query only modified Organisations. Besides the already used filter options, it´s recommended to use the **modifiedAfter** filter option as an addition. When performing a synchronisation on a regular basis, the **modifiedAfter** filter can help to request Organisations modified after the last synchronisation. Please ensure to verify updates to referenced locations in a separate call, as is done via the intial synchronisation." }, "response": [] } ] } ], "description": "StartFragment\n\nSynchronising in a nutshell:\n\n- Initial synchronisation to establish a link between the target data records and the respective source records\n- Delta synchronisation to query modified elements only" } ], "description": "In this folder, the synchronisation of target data (e.g. SPOR OMS, etc.) with individual source systems is explained." } ], "description": "In this folder, some howtos explain how to successfully carry out SPORIFY business processes." } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://sporify.eu", "type": "string" }, { "key": "authorization", "value": "", "type": "string" }, { "key": "tenancyName", "value": "", "type": "string" }, { "key": "usernameOrEmailAddress", "value": "", "type": "string" }, { "key": "password", "value": "", "type": "string" }, { "key": "omssourcelistid", "value": "", "type": "string" }, { "key": "omssourcelistelementid", "value": "", "type": "string" }, { "key": "systemid", "value": "", "type": "string" }, { "key": "resolutionstatusid", "value": "", "type": "string" }, { "key": "datagovernancestatusid", "value": "", "type": "string" }, { "key": "smssourcelistid", "value": "", "type": "string" }, { "key": "smssourcelistelementid", "value": "", "type": "string" }, { "key": "rmssourcelistid", "value": "", "type": "string" }, { "key": "rmssourcelistelementid", "value": "", "type": "string" } ] }