![](\"favicon.png\")
This documentation pertains to the beta release of API v2.
\nWe aim to provide clear and comprehensive information, yet we invite your feedback to further refine the documentation. We welcome any suggestions for improvement, bug reports, or additional comments to enhance the overall utility and accuracy.
\nPlease note that as this is a beta version, some endpoints are subject to potential changes. We will promptly document all modifications in this section and include them in our release notes.
\nThis is the Exivity API specification, and should be used as a reference guide for creating requests and parsing responses. For a more general introduction to Exivity, please refer to our documentation.
\nDownload latest Postman collection from our GitHub repository.
\nContent-Type: application/vnd.api+json\nAccept: application/vnd.api+json\n\nThe default method of authentication against the API is done through a stateless JWT token.
\nIt is also possible to authenticate the API via LDAP or SAML, if your administrator has set up access to either of these systems.
\nThe default method of authentication against the API is done through a stateless JWT token, sent along as an Authentication header. To obtain a token, a request to the API endpoint /v1/auth/token should be made with the user credentials.
Once a token has been generated, please include it in the headers of other requests to allow authorization.
\nExample:
\nAuthorization: Bearer [token]\n\nThe JWT token will expire after 4 hours for security reasons. This value is configurable. Please see /configuration or https://docs.exivity.com/architecture%20concepts/glossary/#authentication-token for more information.
\nEach section of the API Reference contains an object, detailing the different attributes the endpoint accepts.
\nExample:
\nThe follow types appear in this document:
\nintegerfloatdoublestringarrayenum- this will be followed by an array of possible values. e.g enum(charge,quantity)datedatetimetimeDate, datetime and time follow the ISO 8601 standard
\nY - A full numeric representation of a year, 4 digits e.g, 1996, 2021m - Numeric representation of a month, with leading zeros e.g. 01 through 12d - Day of the month, 2 digits with leading zeros e.g. 01 to 31H - 24-hour format of an hour with leading zeros e.g. 00 to 23i - Minutes with leading zeros e.g. 00 to 59s - Seconds with leading zeros e.g. 00 to 59Y-m-d\\TH:i:s\\Z - ISO 8601 datetime e.g. 2022-05-17T13:35:25ZExamples:
\n2017-01Nullable values will have a question mark listed after the type. Examples: integer?, string?
This column states whether a value is changable.
\nIt is possible to include related relationships with a give resource request (see Working with the API -> Include Related Resources for how to do this). The possible relationships are listed under the resource object.
\nExample:
\nSome resources require a relationship to be created e.g. creating a new user required a usergroup. Any required relationships will be give in the Add example of the resource.
\nDifferent variables have double curly brackets around them ({{, }}). These used for placeholders in this documentation. When working with the API, these placeholders should be replaced with real values. Examples include:
{{base_url}} - replace this with your API's url
{{workflow_id}}, {{report_id}}, {{account_id}}, etc - these are placeholders for a specific ID for an object.
Some requests using the JSON:API format accept additional query string parameters.
\nTo filter results, use the filter[attribute] query string parameter.
The following formats are supported for filtering results:
\nExample - get accounts that start with W:
\nGET /accounts?filter[name]=^W\n\nThe filter parameter can occur multiple times in a request to filter by multiple fields.
\nExample - get accounts that start with W and level is set to one:
\nGET /accounts?filter[name]=^W&filter[level]==1\n\nA filter can also use related entities (which don't have to be included in the request with the include parameter).
Example - get users with MANAGE_USERS permission, and an email address ending with \"example.com\":
\nGET /user?filter[usergroup.permissions]=~MANAGE_USERS&filter[email_address]=$example.com\n\nWhen making requests to endpoints which can return more than one entity, results are paginated. The number of results per page and the requested page can be adjusted with the page[limit] and page[offset] query string parameters.
Example:
\nGET /user?page[limit]=50&page[offset]=2\n\nWhen the page limit is set to -1, all results are returned.
The links element in the JSON response contains references to URLs which can be used to navigate the resultset.
The meta element in the JSON response contains a reference to the total number of items in the resultset.
It is possible to sort results by using the sort query string parameter. A descending sort order can be requested by prefixing a hyphen (U+002D).
Example:
\nGET /user?sort=-username\n\nInclusion of related resources in the response can be requested with the include query string parameter. Multiple entities can be specified by separating them with a comma (U+002C). Each endpoint definition specifies which includes can be requested.
Examples:
\nGET /user?include=usergroup,accounts\nGET /user/[id]?include=usergroup,accounts\n\nIt is also possible to fetch relationship data to a single resource using a separate endpoint. Relationships data on resources can be queried and modified by using the /[resource]/[id]/relationships/[relation] endpoint structure.
GET /user/[id]/usergroup\n\nMany endpoint support Atomic Operations. This provides a means to perform multiple βoperationsβ in a linear and atomic manner.
\nAt the top of all endpoints, it states whether or not it supports atomic operations:
\nPlease read the JSON:API Atomic Operations documentation to understand how this works.
\nExample
\nAdd a workflow and a workflow step in a single request:
\n{\n \"atomic:operations\": [\n {\n \"op\": \"add\",\n \"data\": {\n \"type\": \"workflow\",\n \"lid\": \"foo\",\n \"attributes\": {\n \"name\": \"Atomic workflow\",\n \"description\": \"My new atomic workflow\"\n }\n }\n },\n {\n \"op\": \"add\",\n \"data\": {\n \"type\": \"workflowstep\",\n \"lid\": \"bar\",\n \"attributes\": {\n \"type\": \"execute\",\n \"timeout\": 600,\n \"options\": {\n \"command\": \"echo \\\"testing\\\"\"\n }\n },\n \"relationships\": {\n \"workflow\": {\n \"data\": {\n \"type\": \"workflow\",\n \"lid\": \"foo\"\n }\n }\n }\n }\n }\n ]\n}\n\nAll atomic request must be submitted throught the atomic endpoint:
\nPOST {{base_url}}/v2/
See General/Json API atomic operation for more examples.
\nErrors are returned as a JSON object, following the JSON:API error standard. We use HTTP error responses in the status field, to indicate whether the request was a success (2xx) or a failure(4xx, 5xx).
Example:
\n{\n \"errors\": [\n {\n \"status\": \"422\",\n \"title\": \"Attribute validation error\",\n \"detail\": \"Password must contain at least 8 characters.\"\n }\n ]\n}\n\nPossible response codes:
\nIf an authorization token is missing, expired or malformed, an error response will be returned. These errors will always have a 401 Unauthorised status.
Example:
\n{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"AuthException\",\n \"detail\": \"Invalid token provided, please login again.\"\n }\n ]\n}\n\nSome endpoints require a different set of permissions than others. If insufficient permissions are granted to the authenticated user, a 403 Forbidden response is returned.
All API requests are rate limited to avoid overloading the server.
The rate at which you can make requests to the API is limited by client IP address, and is limited at 10 requests per second. The API allows for short request bursts (i.e. you can exceed this limit for a short period of time). If you've exceeded your API rate limit, you'll get back a 503 Service Unavailable response.
Requests containing a user password in the payload are even further rate limited to mitigate brute-force attacks in user credentials.
\nYou can find the terms of service on our website.
\nA simple test to check the system is set up correctly. If all is well, this request should return a simple HTML page with a link to the API documentation.
\nIt is also possible to ask for a JSON response, using the Accept: application/json header.
This will return a 204 response if all is good, or a 500 error with a JSON error message if something is not correct.
\nIn debug mode, this will also contain a meta field, listing the area where the problem is.
\nExivity API\napi reference\n\n\n\n\n\n"}],"_postman_id":"92d28cbd-87ea-48d0-b954-0716a37d24af"},{"name":"JSON API Version information","event":[{"listen":"test","script":{"id":"209ba1c0-e483-45eb-ac35-b1f2eb094a3d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","","pm.test(\"Response contains jsonapi version data\", function () {"," pm.expect(response.jsonapi).to.be.an('object');"," pm.expect(response.jsonapi.version).to.eql('1.1');","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"23e6a667-f3ff-4cb5-9c98-393246d451de","exec":[""],"type":"text/javascript","packages":{}}}],"id":"1ccc1745-4c14-4321-825c-4774e3b1550f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/","urlObject":{"path":["v2",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5cdfbf0f-0faf-4c7d-9da4-bb699ce6fadf","name":"JSON API Version information","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 20 Feb 2023 11:38:47 GMT"},{"key":"Date","value":"Mon, 20 Feb 2023 11:38:47 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X5089b2c8b8a9f43ba7727d989f458a5b"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-qhd1DnWhmfYBJ6yijPsKBoFDr8EEgAjc';style-src 'self' 'nonce-qhd1DnWhmfYBJ6yijPsKBoFDr8EEgAjc';font-src 'self' data:"},{"key":"Request-Id","value":"c41ee291-c35a-48e8-9dea-f7fd8793c289"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.1\"\n },\n \"ext\": [\n \"https://jsonapi.org/ext/atomic\"\n ]\n}"}],"_postman_id":"1ccc1745-4c14-4321-825c-4774e3b1550f"},{"name":"JSON API atomic operation","event":[{"listen":"test","script":{"id":"de991b81-6a91-4f2c-b1db-8c5aa51268ed","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains 3 results\", function () {"," pm.expect(response['atomic:results']).to.be.an('array');"," pm.expect(response['atomic:results'].length).to.eql(3);","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"82ddc79a-c935-4afa-9522-4b0687156065","exec":["pm.environment.set(\"username\", \"admin\");\r","pm.environment.set(\"password\", \"exivity\");\r","\r","const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"d00d58da-6562-45db-bcb1-917dd57e6fb5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json;ext=\"https://jsonapi.org/ext/atomic\"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"atomic:operations\": [\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\",\r\n \"attributes\": {\r\n \"name\": \"Atomic workflow\",\r\n \"description\": \"My new atomic workflow\"\r\n }\r\n }\r\n },\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"lid\": \"bar\",\r\n \"attributes\": {\r\n \"type\": \"execute\",\r\n \"timeout\": 600,\r\n \"options\": {\r\n \"command\": \"echo \\\"testing\\\"\"\r\n }\r\n },\r\n \"relationships\": {\r\n \"workflow\": {\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"lid\": \"bar\",\r\n \"attributes\": {\r\n \"type\": \"extract\",\r\n \"timeout\": 600,\r\n \"options\": {\r\n \"script\": \"Workflow_extractor\",\r\n \"from_date_offset\": \"-2\",\r\n \"to_date_offset\": \"2\",\r\n \"arguments\": \"test1 test2\"\r\n }\r\n },\r\n \"relationships\": {\r\n \"workflow\": {\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/","description":"
Many endpoint support Atomic Operations. This provides a means to perform multiple βoperationsβ in a linear and atomic manner.
\nAt the top of all endpoints, it states whether or not it supports atomic operations.
\nExample: Atomic support: βοΈ
\nPlease read the JSON:API Atomic Operations documentation and see the examples to understand how this works.
\n","urlObject":{"path":["v2",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"81c107bf-e029-4e98-bd0b-ef99d98dc4a3","name":"Example add operation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"atomic:operations\": [{\r\n \"op\": \"add\",\r\n \"ref\": {\r\n \"type\": \"workflow\"\r\n },\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"attributes\": {\r\n \"name\": \"Atomic workflow\",\r\n \"description\": \"My new atomic workflow\"\r\n }\r\n }\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 22 Apr 2021 11:34:13 GMT"},{"key":"Date","value":"Thu, 22 Apr 2021 11:34:13 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-Xzj1vgBU6i1N2MrvT0tIZQnRvqYytAoL';style-src 'self' 'nonce-Xzj1vgBU6i1N2MrvT0tIZQnRvqYytAoL';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"data\": {\n \"type\": \"workflow\",\n \"id\": \"39\",\n \"attributes\": {\n \"name\": \"Atomic workflow\",\n \"description\": \"My new atomic workflow\",\n \"created_at\": \"2021-04-22T11:34:13Z\",\n \"updated_at\": \"2021-04-22T11:34:13Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflows/39\"\n },\n \"relationships\": {\n \"runs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/39/relationships/runs\",\n \"related\": \"http://localhost:8012/2/workflow/39/runs\"\n }\n },\n \"steps\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/39/relationships/steps\",\n \"related\": \"http://localhost:8012/2/workflow/39/steps\"\n }\n },\n \"schedules\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/39/relationships/schedules\",\n \"related\": \"http://localhost:8012/2/workflow/39/schedules\"\n }\n }\n }\n }\n }\n]"},{"id":"e18a6b5b-d87c-4262-86f0-08f9638d68f5","name":"Example update operation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"atomic:operations\": [{\r\n \"op\": \"update\",\r\n \"ref\": {\r\n \"type\": \"workflow\",\r\n \"id\": \"42\"\r\n },\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"attributes\": {\r\n \"description\": \"My new description\"\r\n }\r\n }\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 22 Apr 2021 11:46:57 GMT"},{"key":"Date","value":"Thu, 22 Apr 2021 11:46:57 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-ZAedxzHUyVKl3GBcOFC76Twiy4VAL5X9';style-src 'self' 'nonce-ZAedxzHUyVKl3GBcOFC76Twiy4VAL5X9';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"data\": {\n \"type\": \"workflow\",\n \"id\": \"42\",\n \"attributes\": {\n \"name\": \"Atomic workflow\",\n \"description\": \"My new description\",\n \"created_at\": \"2021-04-22T11:37:32Z\",\n \"updated_at\": \"2021-04-22T11:46:57Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflows/42\"\n },\n \"relationships\": {\n \"runs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/42/relationships/runs\",\n \"related\": \"http://localhost:8012/2/workflow/42/runs\"\n }\n },\n \"steps\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/42/relationships/steps\",\n \"related\": \"http://localhost:8012/2/workflow/42/steps\"\n }\n },\n \"schedules\": {\n \"links\": {\n \"self\": \"http://localhost:8012/2/workflow/42/relationships/schedules\",\n \"related\": \"http://localhost:8012/2/workflow/42/schedules\"\n }\n }\n }\n }\n }\n]"},{"id":"f7b0ce99-e1d5-4496-9d06-7f75fb9ce024","name":"Example remove operation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"atomic:operations\": [{\r\n \"op\": \"remove\",\r\n \"ref\": {\r\n \"type\": \"workflow\",\r\n \"id\": \"42\"\r\n }\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 22 Apr 2021 11:49:44 GMT"},{"key":"Date","value":"Thu, 22 Apr 2021 11:49:44 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-PMo5pR8Ar3U9s6huWTySgjgcMcEjNbmt';style-src 'self' 'nonce-PMo5pR8Ar3U9s6huWTySgjgcMcEjNbmt';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"[\n {}\n]"},{"id":"6a914873-9059-4462-bc7c-d586b8016430","name":"Example LID operation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json;ext=\"https://jsonapi.org/ext/atomic\"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"atomic:operations\": [\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\",\r\n \"attributes\": {\r\n \"name\": \"Atomic workflow\",\r\n \"description\": \"My new atomic workflow\"\r\n }\r\n }\r\n },\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"lid\": \"bar\",\r\n \"attributes\": {\r\n \"type\": \"execute\",\r\n \"timeout\": 600,\r\n \"options\": {\r\n \"command\": \"echo \\\"testing\\\"\"\r\n }\r\n },\r\n \"relationships\": {\r\n \"workflow\": {\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n {\r\n \"op\": \"add\",\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"lid\": \"bar\",\r\n \"attributes\": {\r\n \"type\": \"extract\",\r\n \"timeout\": 600,\r\n \"options\": {\r\n \"script\": \"Workflow_extractor\",\r\n \"from_date_offset\": \"-2\",\r\n \"to_date_offset\": \"2\",\r\n \"arguments\": \"test1 test2\"\r\n }\r\n },\r\n \"relationships\": {\r\n \"workflow\": {\r\n \"data\": {\r\n \"type\": \"workflow\",\r\n \"lid\": \"foo\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 24 Oct 2022 10:22:46 GMT"},{"key":"Date","value":"Mon, 24 Oct 2022 10:22:46 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Clockwork-Id","value":"X5d455abd22600f8d9d86063df63c54e9"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-S896SdL15u7OJceG9L3ize8QBBKRxymk';style-src 'self' 'nonce-S896SdL15u7OJceG9L3ize8QBBKRxymk';font-src 'self' data:"},{"key":"Request-Id","value":"819af2bc-27e8-4b91-9689-bafb21dfecfa"}],"cookie":[],"responseTime":null,"body":"{\n \"atomic:results\": [\n {\n \"data\": {\n \"type\": \"workflow\",\n \"id\": \"11\",\n \"attributes\": {\n \"name\": \"Atomic workflow\",\n \"description\": \"My new atomic workflow\",\n \"created_at\": \"2022-10-24T10:22:46Z\",\n \"updated_at\": \"2022-10-24T10:22:46Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflows/11\"\n },\n \"relationships\": {\n \"runs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflows/11/relationships/runs\",\n \"related\": \"http://localhost:8012/v2/workflows/11/runs\"\n }\n },\n \"steps\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflows/11/relationships/steps\",\n \"related\": \"http://localhost:8012/v2/workflows/11/steps\"\n }\n },\n \"schedules\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflows/11/relationships/schedules\",\n \"related\": \"http://localhost:8012/v2/workflows/11/schedules\"\n }\n }\n }\n }\n },\n {\n \"data\": {\n \"type\": \"workflowstep\",\n \"id\": \"11\",\n \"attributes\": {\n \"type\": \"execute\",\n \"options\": {\n \"command\": \"echo \\\"testing\\\"\"\n },\n \"timeout\": 600,\n \"wait\": true\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/11\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/11/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/11/workflow\"\n }\n },\n \"steplogs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/11/relationships/steplogs\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/11/steplogs\"\n }\n },\n \"previous\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/11/relationships/previous\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/11/previous\"\n }\n }\n }\n }\n },\n {\n \"data\": {\n \"type\": \"workflowstep\",\n \"id\": \"12\",\n \"attributes\": {\n \"type\": \"extract\",\n \"options\": {\n \"script\": \"Workflow_extractor\",\n \"from_date_offset\": -2,\n \"to_date_offset\": 2,\n \"arguments\": \"test1 test2\",\n \"environment_id\": null\n },\n \"timeout\": 600,\n \"wait\": true\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/12\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/12/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/12/workflow\"\n }\n },\n \"steplogs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/12/relationships/steplogs\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/12/steplogs\"\n }\n },\n \"previous\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/12/relationships/previous\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/12/previous\"\n }\n }\n }\n }\n }\n ]\n}"}],"_postman_id":"d00d58da-6562-45db-bcb1-917dd57e6fb5"}],"id":"65189fe8-c299-4e40-be45-576529809cec","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4b5edc3a-cee4-4aa2-8f41-142c1261674f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d45bc86b-e974-4dcd-8e73-9524b254a371","type":"text/javascript","exec":[""]}}],"_postman_id":"65189fe8-c299-4e40-be45-576529809cec","description":""},{"name":"Authentication","item":[{"name":"/token","item":[{"name":"Generate token","event":[{"listen":"test","script":{"id":"da5dbad0-fee4-4342-b1cc-6c5eeb1f06f7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data (token)\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('auth');"," pm.expect(response.data.id).to.be.a('string');"," pm.expect(response.data.attributes.token).to.be.a('string');"," pm.expect(response.data.attributes.permissions).to.be.an('array');"," pm.expect(response.data.attributes.permissions).to.eql([\"*\"]);","});","","// pm.test(\"Response contains relationship (user)\", function () {","// pm.expect(response.data.relationships).to.be.an('object');","// pm.expect(response.data.relationships.user).to.be.an('object');","// pm.expect(response.data.relationships.user.data).to.be.an('object');","// pm.expect(response.data.relationships.user.data.type).to.eql('user');","// pm.expect(response.data.relationships.user.data.id).to.be.a('string');","// });","","pm.environment.set(\"token\", response.data.attributes.token);","console.log('SET token: ' + pm.environment.get(\"token\"));","console.log(response.data.relationships);","// pm.environment.set(\"user_id\", response.data.relationships.user.data.id);","// console.log('SET user_id: ' + pm.environment.get(\"user_id\"));"],"type":"text/javascript","packages":{}}}],"id":"8053b1ca-b271-4a28-b449-0d35e2e5812d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","description":"string
\n","type":"text"},{"key":"password","value":"{{password}}","description":"string
\n","type":"text"}]},"url":"{{base_url}}/v2/auth/token?include=user","description":"β‘ Not JSON:API compliant
\nAtomic support: β
\nGenerate a new JWT authentication token.
\n","urlObject":{"path":["v2","auth","token"],"host":["{{base_url}}"],"query":[{"key":"include","value":"user"}],"variable":[]}},"response":[{"id":"84b213eb-8ec3-4093-ab51-6b3065b0d741","name":"Generate token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","description":"string","type":"text"},{"key":"password","value":"{{password}}","description":"string","type":"text"}]},"url":"{{base_url}}/v2/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 17 Oct 2024 09:08:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xe10bfe0f033ec0bf011e0341a36e0b95"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xe10bfe0f033ec0bf011e0341a36e0b95"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-EQyi3YQ0HGuPQy7PFvaaFU5C58a2U2UL';style-src 'self' 'nonce-EQyi3YQ0HGuPQy7PFvaaFU5C58a2U2UL';font-src 'self' data:"},{"key":"Request-Id","value":"6a4533ed-fd50-4e49-8ed1-d58640835c76"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"auth\",\n \"id\": \"2024-10-17 09:08:25acbfde23-79b2-40af-abfa-99b51c3bd5d0\",\n \"attributes\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MjkxNTYxMDUsImV4cCI6MTcyOTE3MDUwNSwidXNlciI6ImFjYmZkZTIzLTc5YjItNDBhZi1hYmZhLTk5YjUxYzNiZDVkMCIsImZpbmdlcnByaW50IjoiMmZjNmVjOWZhNmVkNDBlZWQxOTE5OTdkNmNmNTE4MTljMThhYWZkMiJ9.vfbgO75htJVjZTZ1boqBf4iZMrMfoMfqLuBn6HR86To\",\n \"permissions\": [\n \"*\"\n ]\n }\n }\n}"},{"id":"b48f7f23-01d4-4a98-b4d1-2136c5eed5f7","name":"Generate token with user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","description":"string","type":"text"},{"key":"password","value":"{{password}}","description":"string","type":"text"}]},"url":{"raw":"{{base_url}}/v2/auth/token?include=user","host":["{{base_url}}"],"path":["v2","auth","token"],"query":[{"key":"include","value":"user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 17 Oct 2024 09:29:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xb8e4cd05e7680d06082cb5fd31633c90"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xb8e4cd05e7680d06082cb5fd31633c90"},{"key":"ETag","value":"\"0f2a3a3252d0574240008a751f4c03c0\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-r0CMmPUomvfmKgBPpHoF5kbtdozXsJVr';style-src 'self' 'nonce-r0CMmPUomvfmKgBPpHoF5kbtdozXsJVr';font-src 'self' data:"},{"key":"Request-Id","value":"aa1d0771-5ed7-4689-8084-e83bb40a96c7"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"auth\",\n \"id\": \"2024-10-17 09:29:23acbfde23-79b2-40af-abfa-99b51c3bd5d0\",\n \"attributes\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MjkxNTczNjMsImV4cCI6MTcyOTE3MTc2MywidXNlciI6ImFjYmZkZTIzLTc5YjItNDBhZi1hYmZhLTk5YjUxYzNiZDVkMCIsImZpbmdlcnByaW50IjoiNGNhNWNhMDY5YTY2NDFkMjE4MmMwNjcyMzgxMjMwMjVlYWFjYjY3YiJ9._fHoeECjBe9aAHybQZ8xN3SS5vxF1xYoHfntIq8zHGo\",\n \"permissions\": [\n \"*\"\n ]\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"acbfde23-79b2-40af-abfa-99b51c3bd5d0\"\n }\n }\n }\n },\n \"included\": [\n {\n \"type\": \"user\",\n \"id\": \"acbfde23-79b2-40af-abfa-99b51c3bd5d0\",\n \"attributes\": {\n \"username\": \"admin\",\n \"email_address\": \"tester@exivity.com\",\n \"account_access_type\": \"all\",\n \"source\": \"local\",\n \"display_name\": \"admin\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0\"\n },\n \"relationships\": {\n \"usergroup\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/relationships/usergroup\",\n \"related\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/usergroup\"\n }\n },\n \"accounts\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/relationships/accounts\",\n \"related\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/accounts\"\n }\n },\n \"channels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/relationships/channels\",\n \"related\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/channels\"\n }\n },\n \"notificationchannels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/relationships/notificationchannels\",\n \"related\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/notificationchannels\"\n }\n },\n \"notificationsubscriptions\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/relationships/notificationsubscriptions\",\n \"related\": \"http://localhost:8012/v2/users/acbfde23-79b2-40af-abfa-99b51c3bd5d0/notificationsubscriptions\"\n }\n }\n }\n }\n ]\n}"}],"_postman_id":"8053b1ca-b271-4a28-b449-0d35e2e5812d"},{"name":"Refresh token","event":[{"listen":"test","script":{"id":"4a0502e5-e53a-4143-978d-555dce8bf99d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains token\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('auth');"," pm.expect(response.data.id).to.be.a('string');"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes.token).to.be.a('string');","});","","pm.test(\"Response contains permissions\", function () {"," pm.expect(response.data.attributes.permissions).to.be.an('array')"," pm.expect(response.data.attributes.permissions).to.eql([\"*\"]);","});",""],"type":"text/javascript"}}],"id":"e2e33c0f-12db-45fc-a041-e423aa5ab59b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/auth/token?include=","description":"Atomic support: β
\n","urlObject":{"path":["v2","auth","token"],"host":["{{base_url}}"],"query":[{"description":{"content":"Include additional related resources. Possible values: user.
Atomic support: β
\nOn success, a HTTP 204 No Content success status response will be returned.
The following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"39442ed1-c5f1-44de-b4c1-2bde691a3383","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03723b09-b82a-4528-ba18-d9dc507044b0","type":"text/javascript","exec":[""]}}],"_postman_id":"62b91f49-d7c8-41bf-8185-0fd32ae836a5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f0fc69bf-69f1-48e8-b770-651ead26cb4d","id":"f0fc69bf-69f1-48e8-b770-651ead26cb4d","name":"Authentication","type":"folder"}}},{"name":"/saml","item":[{"name":"Initiate SAML login request","event":[{"listen":"test","script":{"id":"afef4837-a418-4b1a-884c-4fc702ff1354","exec":["pm.test(\"Status code is 422 or 500\", function () {"," pm.expect(pm.response.code).to.be.oneOf([422, 500])","});","","console.log('---- Response: ----');","(pm.response.text())?pm.response.text():pm.response","if (pm.response.text()) {"," console.log(pm.response.text());","} else {"," console.log('No response');","}",""],"type":"text/javascript"}}],"id":"b5ffb4c4-faa3-4f03-a46e-c682bfa51ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base_url}}/v2/auth/saml/login?return_url=","description":"Atomic support: β
\nRedirects to SAML Identity Provider SSO URL set in the SAML configuration. After a successful authentication (possibly interactive), it will redirect back to this APIs ACS endpoint.
\n","urlObject":{"path":["v2","auth","saml","login"],"host":["{{base_url}}"],"query":[{"key":"return_url","value":""}],"variable":[]}},"response":[],"_postman_id":"b5ffb4c4-faa3-4f03-a46e-c682bfa51ee3"},{"name":"Initiate SAML logout request","id":"7e42756b-aaa6-45b2-bc52-efe0a00422d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/auth/saml/logout?return_url","description":"Atomic support: β
\nRedirects to SAML Identity Provider SLO URL set in the SAML configuration. After the user has been logged out, it will redirect back to this APIs SLS endpoint.
\n","urlObject":{"path":["v2","auth","saml","logout"],"host":["{{base_url}}"],"query":[{"description":{"content":"Glass URL to return to after logging out. If not specified, inferred from Referer header.
\n","type":"text/plain"},"key":"return_url","value":null}],"variable":[]}},"response":[],"_postman_id":"7e42756b-aaa6-45b2-bc52-efe0a00422d9"},{"name":"Entity ID endpoint","id":"86a6cd2f-24e4-4260-8076-00a0d3da6e5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/auth/saml/metadata","description":"Atomic support: β
\nMetadata about the SAML Service Provider instance will be published at this URL.
\n","urlObject":{"path":["v2","auth","saml","metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86a6cd2f-24e4-4260-8076-00a0d3da6e5e"},{"name":"ACS endpoint","id":"02c4bb13-7466-403f-8dfc-efb46abb9220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/auth/saml/acs","description":"Atomic support: β
\nAssertion Consumer Service. If the received response from the SAML Identity Provider is valid, redirects to the Exivity dashboard.
\n","urlObject":{"path":["v2","auth","saml","acs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02c4bb13-7466-403f-8dfc-efb46abb9220"},{"name":"SLS endpoint","id":"b6846e82-f317-44c3-87ea-494dfd8278fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/auth/saml/sls","description":"Atomic support: β
\nSingle Logout Service. If the received response from the SAML Identity Provider is valid, redirects back to the login screen of Exivity.
\n","urlObject":{"path":["v2","auth","saml","sls"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6846e82-f317-44c3-87ea-494dfd8278fa"}],"id":"e90583db-6476-4a12-a431-18e742b2a701","description":"Endpoints for supporting Single Sign-On authentication flow using SAML.
\nExivity documentation: https://docs.exivity.com/Security/Authentication/SAML2
\n","event":[{"listen":"prerequest","script":{"id":"757f8f94-dcd7-4478-8abd-37d53a25bc8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ac3c641e-36f9-41fb-aab1-1eef9cf62541","type":"text/javascript","exec":[""]}}],"_postman_id":"e90583db-6476-4a12-a431-18e742b2a701","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f0fc69bf-69f1-48e8-b770-651ead26cb4d","id":"f0fc69bf-69f1-48e8-b770-651ead26cb4d","name":"Authentication","type":"folder"}}},{"name":"/resetpassword","item":[{"name":"Request a password reset","event":[{"listen":"test","script":{"id":"15907a71-1a6f-4dca-b97a-bd8993afcd6c","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6c3305d3-1f70-4273-9ce1-e250a86cd4f6","exec":[""],"type":"text/javascript"}}],"id":"3c61c017-f355-489c-9202-6d0a46ec7df2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email_address\": \"{{email_address}}\"\n}"},"url":"{{base_url}}/v2/auth/resetpassword","description":"Atomic support: β
\nThis request required an email address. It checks that it is valid in our system and they email the user a reset token.
\nOn success, a HTTP 204 No Content success status response will be returned.
Atomic support: β
\nThis step uses the reset token send in an email to validate the user and then reset their password.
\n","urlObject":{"path":["v2","auth","resetpassword"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4386c6ab-7f08-4d52-b7b1-450161cc206e","name":"Success - Perform a password reset","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"1cfcb1b392d024af0f012e4ee11bc36f5b71194f5caa5a0912b33ec5679764a0\",\n\t\"username\": \"Alice\",\n\t\"password\": \"eS*40D0QGVUGDn.e\",\n\t\"password_confirmation\": \"eS*40D0QGVUGDn.e\"\n}"},"url":"{{base_url}}/v2/auth/resetpassword"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 27 May 2024 12:56:30 GMT"},{"key":"X-Clockwork-Id","value":"X8f6ce0628699522fbda55027e595cb3d"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X8f6ce0628699522fbda55027e595cb3d"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-8RlgJg7JVZ4VKDIJpkRrPAdlGbt4ksIU';style-src 'self' 'nonce-8RlgJg7JVZ4VKDIJpkRrPAdlGbt4ksIU';font-src 'self' data:"},{"key":"Request-Id","value":"1ab0c053-4ced-4341-8224-650b08de4688"}],"cookie":[],"responseTime":null,"body":null},{"id":"d14b7de3-ceb8-4da7-8ae2-9749d2b21dca","name":"Fail - Perform a password reset","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"f2eceecc80de33f128618de78a964a90ab4b55450cb090ec1dbaacde4f2a6bb0\",\n\t\"username\": \"Alice\",\n\t\"password\": \"eS*40D0QGVUGDn.e\",\n\t\"password_confirmation\": \"eS*40D0QGVUGDn.e\"\n}"},"url":"{{base_url}}/v2/auth/resetpassword"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 27 May 2024 12:57:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xf72c8aa50e69cfa496b2f5c530901122"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xf72c8aa50e69cfa496b2f5c530901122"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-vryRUSRhfep7qkCNaxJiEf5Xi8Ije08e';style-src 'self' 'nonce-vryRUSRhfep7qkCNaxJiEf5Xi8Ije08e';font-src 'self' data:"},{"key":"Request-Id","value":"1517be42-31c9-474b-bbf7-48b16767a317"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"HttpException\",\n \"detail\": \"The request could not be processed. Please ensure you are using the correct username and reset token.\"\n }\n ]\n}"}],"_postman_id":"4095aa25-16ea-40db-9abd-9b49a6d1f230"}],"id":"b09ccfea-fd37-4669-a31a-a01743a70dea","description":"If a user forgets their password, this endpoint can be used to generate a new password. There are two steps:
\nThe default method of authentication against the API is done through a stateless JWT token.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#authentication
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"39a4cea9-e466-40eb-bb9a-a3ac84227380","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e515eba-9765-4450-9a0c-65ae1a9ef30e","type":"text/javascript","exec":[""]}}],"_postman_id":"f0fc69bf-69f1-48e8-b770-651ead26cb4d"},{"name":"Reports","item":[{"name":"/reportdefinitions","item":[{"name":"Retrieve a list of report definitions","event":[{"listen":"test","script":{"id":"b6051dba-eb8a-45de-8d83-3010c5b619d5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"80b3035d-e9ce-41fb-b2de-c8653f8da33a","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}}],"id":"76814b88-4636-42c0-9508-6f7b6fcee3a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/reportdefinitions?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","reportdefinitions"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: accounts, metadatadefinitions, dataset, budgets.
The report object contains the definition of how to generate a report, and once the report has run, the report data itself.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#report
\nThe report levels are contained inside level_key objects.
\nThe following relationships can be included:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ee2968e7-e592-4ad8-8f1f-610eedc615be","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9952397e-a7fa-4f36-95f8-b73206f96a9e","type":"text/javascript","exec":[""]}}],"_postman_id":"fb60cf9c-707d-4e07-b6c3-9f33cb1c687a"},{"name":"/reportdata","item":[{"name":"Get report data","event":[{"listen":"prerequest","script":{"id":"646a1877-9597-4fac-a804-5bbcf142fc5b","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.requireReportDefinition)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"e57abd37-0a0a-4ec0-a082-bdd5edb88f80","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');"," pm.expect(response.data[0].type).to.be.a('string');"," pm.expect(response.data[0].id).to.be.a('string');"," pm.expect(response.data[0].attributes).to.be.an('object');"," pm.expect(response.data[0].attributes).to.have.property('rate_id');"," pm.expect(response.data[0].attributes).to.have.property('subtotal_quantity');"," pm.expect(response.data[0].attributes).to.have.property('total_quantity');"," pm.expect(response.data[0].attributes).to.have.property('unit_based_subtotal_charge');"," pm.expect(response.data[0].attributes).to.have.property('interval_based_subtotal_charge');"," pm.expect(response.data[0].attributes).to.have.property('subtotal_charge');"," pm.expect(response.data[0].attributes).to.have.property('total_charge');"," pm.expect(response.data[0].attributes).to.have.property('total_cogs');"," pm.expect(response.data[0].attributes).to.have.property('total_net');","});","",""],"type":"text/javascript"}}],"id":"60541713-c4f0-4a85-a5a1-10338b67217b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/reportdata/:reportdefinition_id/run?start={{start}}&end={{end}}&dimension=&timeline=&depth=&include=&filter[field]&format=&precision=&progress=&csv_delimiter=&csv_decimal_separator&summary_options=","description":"The output format when either json or csv is selected as the format parameter:
The output format of the embedded adjustments data:
\n","urlObject":{"path":["v2","reportdata",":reportdefinition_id","run"],"host":["{{base_url}}"],"query":[{"description":{"content":"The start of the date range (inclusive) you want to run the report for in yyyy-mm-dd format. Defaults to the current date.
The end of the date range (inclusive) you want to run the report for in yyyy-mm-dd format. Defaults to the current date.
The dimension you want to include in the output. One of accounts, services or instances (or a combination of those as a comma separated list). Defaults to accounts,services. When instances is included, price and quantity adjustments and minimum commit are not reflected in the data.
One of day, month or none. Defaults to day.
The depth in the report definition you want to report on. Defaults to 1.
\n","type":"text/plain"},"key":"depth","value":""},{"description":{"content":"Optionally specify a list of extra fields you want to output with the results. Possible fields are account_key, account_name, service_key, service_description, servicecategory_name, start_date, end_date, adjustment_name (or a combination of those as a comma separated list). The account and service fields are only available if their respective dimension is included in the request.
Optionally filter results by this attribute. Possible fields are account_id, parent_account_id, service_id, servicecategory_id, instance. This parameter can occur multiple times in a request to filter by multiple fields.
One of json, csv or pdf/summary. Default to json.
Specify highest to get raw precision, use configuration otherwise. Defaults to configuration.
When set to 1 and format is json, results will be streamed with progress indicator in response body. When format is csv, results are always streamed without progress indicator, pdf/Γnvoice is never streamed. Defaults to 1.
The CSV delimiter to use. Only applicable when format is set to csv. Possible values: ,, ;, :, \\t, |. Leave blank to use configuration.
The decimal separator to use. Only applicable when format is set to csv. Possible values: ,, .. Leave blank to use configuration.
List of options for the pdf/summary format, in a comma seperated list. Possible options: consolidated, accounts, services, instances_by_instance and instances_by_service. Defaults to services.
ID of report to run
\n","type":"text/plain"},"type":"any","value":"{{reportdefinition_id}}","key":"reportdefinition_id"}]}},"response":[{"id":"48743251-1d4d-461c-af1c-990d9b7efebb","name":"Get report data","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v2/reports/:report_id/run?start={{start}}&end={{end}}&dimension=&timeline=&depth=&include=&filter[field]&format=&precision=&progress=&csv_delimiter=&csv_decimal_separator&summary_options=","host":["{{base_url}}"],"path":["v2","reports",":report_id","run"],"query":[{"key":"start","value":"{{start}}","description":"The start of the date range (inclusive) you want to run the report for in `yyyy-mm-dd` format. Defaults to the current date."},{"key":"end","value":"{{end}}","description":"The end of the date range (inclusive) you want to run the report for in `yyyy-mm-dd` format. Defaults to the current date."},{"key":"dimension","value":"","description":"The dimension you want to include in the output. One of `accounts`, `services` or `instances` (or a combination of those as a comma separated list). Defaults to `accounts,services`. When `instances` is included, price and quantity adjustments and minimum commit are not reflected in the data."},{"key":"timeline","value":"","description":"One of `day`, `month` or `none`. Defaults to `day`."},{"key":"depth","value":"","description":"The depth in the report definition you want to report on. Defaults to 1."},{"key":"include","value":"","description":"Optionally specify a list of extra fields you want to output with the results. Possible fields are `account_key`, `account_name`, `service_key`, `service_description`, `servicecategory_name`, `start_date`, `end_date`, `adjustment_name` (or a combination of those as a comma separated list). The account and service fields are only available if their respective dimension is included in the request."},{"key":"filter[field]","value":null,"description":"Optionally filter the output by the supplied field. Possible fields are `account_id`, `parent_account_id`, `service_id`, `servicecategory_id`, `instance`. This parameter can occur multiple times in a request to filter by multiple fields."},{"key":"format","value":"","description":"One of `json`, `csv` or `pdf/summary`. Default to `json`."},{"key":"precision","value":"","description":"Specify `highest` to get raw precision, use configuration otherwise. Defaults to `configuration`."},{"key":"progress","value":"","description":"When set to `1` and format is `json`, results will be streamed with progress indicator in response body. When format is `csv`, results are always streamed without progress indicator, `pdf/Γnvoice` is never streamed. Defaults to `1`."},{"key":"csv_delimiter","value":"","description":"The CSV delimiter to use. Only applicable when `format` is set to `csv`. Possible values: `,`, `;`, `:`, `\\t`, `|`. Leave blank to use configuration."},{"key":"csv_decimal_separator","value":null,"description":"The decimal separator to use. Only applicable when `format` is set to `csv`. Possible values: `,`, `.`. Leave blank to use configuration."},{"key":"summary_options","value":"","description":"List of options for the pdf/summary format, in a comma seperated list. Possible options: `consolidated`, `accounts`, `services`, `instances_by_instance` and `instances_by_service`. Defaults to `services`."}],"variable":[{"id":"78dc38b4-990e-4267-b9c4-1e8919da61ee","key":"report_id","value":"{{report_id}}","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 19 May 2022 15:18:18 GMT"},{"key":"Date","value":"Thu, 19 May 2022 15:18:18 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xacc387a439f53c6c50277701a698ec42"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xacc387a439f53c6c50277701a698ec42"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-6A7UAvMgVvOkdyWY1qvkOGjJpzVHLIfX';style-src 'self' 'nonce-6A7UAvMgVvOkdyWY1qvkOGjJpzVHLIfX';font-src 'self' data:"},{"key":"Request-Id","value":"66a14368-6869-41b3-b2f9-7d98dc231387"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"report\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"Modified test report - scale one-to-one experiences\",\n \"dset\": \"test.usage\",\n \"created\": \"2022-05-19T14:50:51Z\",\n \"last_updated\": \"2022-05-19T14:51:23Z\",\n \"lvl1_key_col\": \"Customer\",\n \"lvl1_name_col\": \"Customer\",\n \"lvl1_label\": \"Customer\",\n \"lvl1_metadata_definition_id\": null,\n \"lvl2_key_col\": \"Reseller\",\n \"lvl2_name_col\": \"Reseller\",\n \"lvl2_label\": \"Reseller\",\n \"lvl2_metadata_definition_id\": null,\n \"lvl3_key_col\": \"\",\n \"lvl3_name_col\": \"\",\n \"lvl3_label\": \"\",\n \"lvl3_metadata_definition_id\": null,\n \"lvl4_key_col\": \"\",\n \"lvl4_name_col\": \"\",\n \"lvl4_label\": \"\",\n \"lvl4_metadata_definition_id\": null,\n \"lvl5_key_col\": \"\",\n \"lvl5_name_col\": \"\",\n \"lvl5_label\": \"\",\n \"lvl5_metadata_definition_id\": null,\n \"depth\": 2,\n \"data_status\": {\n \"first_date\": \"2017-08-25\",\n \"last_date\": \"2017-08-27\",\n \"missing\": 0,\n \"errors\": 0,\n \"status\": [\n {\n \"date\": \"2017-08-25\",\n \"missing\": false,\n \"column_status\": \"ok\",\n \"account_sync\": true,\n \"prepared\": true\n },\n {\n \"date\": \"2017-08-26\",\n \"missing\": false,\n \"column_status\": \"ok\",\n \"account_sync\": true,\n \"prepared\": true\n },\n {\n \"date\": \"2017-08-27\",\n \"missing\": false,\n \"column_status\": \"ok\",\n \"account_sync\": true,\n \"prepared\": true\n }\n ]\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/reports/4\"\n },\n \"relationships\": {\n \"accounts\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/reports/4/relationships/accounts\",\n \"related\": \"http://localhost:8012/v2/reports/4/accounts\"\n }\n },\n \"metadatadefinitions\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/reports/4/relationships/metadatadefinitions\",\n \"related\": \"http://localhost:8012/v2/reports/4/metadatadefinitions\"\n }\n },\n \"dataset\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/reports/4/relationships/dataset\",\n \"related\": \"http://localhost:8012/v2/reports/4/dataset\"\n }\n },\n \"budgets\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/reports/4/relationships/budgets\",\n \"related\": \"http://localhost:8012/v2/reports/4/budgets\"\n }\n }\n }\n },\n \"meta\": {\n \"report\": [\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"2.000000\",\n \"total_quantity\": \"2.000000\",\n \"unit_based_subtotal_charge\": \"5.00\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"5.00\",\n \"total_charge\": \"5.00\",\n \"total_cogs\": \"4.40\",\n \"total_net\": \"0.60\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"56\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"2.000000\",\n \"total_quantity\": \"2.000000\",\n \"unit_based_subtotal_charge\": \"2.40\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"2.40\",\n \"total_charge\": \"2.40\",\n \"total_cogs\": \"1.60\",\n \"total_net\": \"0.80\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"1.20000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"56\",\n \"service_id\": \"65\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"116.000000\",\n \"total_quantity\": \"116.000000\",\n \"unit_based_subtotal_charge\": \"1985.04\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"1985.04\",\n \"total_charge\": \"1985.04\",\n \"total_cogs\": \"1600.80\",\n \"total_net\": \"384.24\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"17.11240000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"56\",\n \"service_id\": \"66\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"11.000000\",\n \"total_quantity\": \"11.000000\",\n \"unit_based_subtotal_charge\": \"27.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"27.50\",\n \"total_charge\": \"27.50\",\n \"total_cogs\": \"24.20\",\n \"total_net\": \"3.30\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"57\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"4.000000\",\n \"total_quantity\": \"4.000000\",\n \"unit_based_subtotal_charge\": \"4.80\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"4.80\",\n \"total_charge\": \"4.80\",\n \"total_cogs\": \"3.20\",\n \"total_net\": \"1.60\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"1.20000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"57\",\n \"service_id\": \"65\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"120.000000\",\n \"total_quantity\": \"120.000000\",\n \"unit_based_subtotal_charge\": \"240.04\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"240.04\",\n \"total_charge\": \"240.04\",\n \"total_cogs\": \"120.02\",\n \"total_net\": \"120.01\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.00030000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"57\",\n \"service_id\": \"67\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"3.111100\",\n \"total_quantity\": \"3.111100\",\n \"unit_based_subtotal_charge\": \"7.78\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"7.78\",\n \"total_charge\": \"7.78\",\n \"total_cogs\": \"6.84\",\n \"total_net\": \"0.93\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"58\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"1.999900\",\n \"total_quantity\": \"1.999900\",\n \"unit_based_subtotal_charge\": \"2.40\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"2.40\",\n \"total_charge\": \"2.40\",\n \"total_cogs\": \"1.60\",\n \"total_net\": \"0.80\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"1.20000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"58\",\n \"service_id\": \"65\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"3.000000\",\n \"total_quantity\": \"3.000000\",\n \"unit_based_subtotal_charge\": \"4.40\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"4.40\",\n \"total_charge\": \"4.40\",\n \"total_cogs\": \"33.33\",\n \"total_net\": \"-28.93\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"1.46612903\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"58\",\n \"service_id\": \"68\",\n \"servicecategory_id\": \"48\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"7.100000\",\n \"total_quantity\": \"7.100000\",\n \"unit_based_subtotal_charge\": \"10.41\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"10.41\",\n \"total_charge\": \"10.41\",\n \"total_cogs\": \"78.88\",\n \"total_net\": \"-68.47\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"1.46612903\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170825\",\n \"account_id\": \"59\",\n \"service_id\": \"68\",\n \"servicecategory_id\": \"48\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"2.000000\",\n \"total_quantity\": \"2.000000\",\n \"unit_based_subtotal_charge\": \"5.00\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"5.00\",\n \"total_charge\": \"5.00\",\n \"total_cogs\": \"4.40\",\n \"total_net\": \"0.60\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170826\",\n \"account_id\": \"56\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"116.000000\",\n \"total_quantity\": \"116.000000\",\n \"unit_based_subtotal_charge\": \"1996.77\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"1996.77\",\n \"total_charge\": \"1996.77\",\n \"total_cogs\": \"1612.43\",\n \"total_net\": \"384.33\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"17.21350000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170826\",\n \"account_id\": \"56\",\n \"service_id\": \"66\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"11.000000\",\n \"total_quantity\": \"11.000000\",\n \"unit_based_subtotal_charge\": \"27.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"27.50\",\n \"total_charge\": \"27.50\",\n \"total_cogs\": \"24.20\",\n \"total_net\": \"3.30\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170826\",\n \"account_id\": \"57\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"119.798000\",\n \"total_quantity\": \"119.798000\",\n \"unit_based_subtotal_charge\": \"239.63\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"239.63\",\n \"total_charge\": \"239.63\",\n \"total_cogs\": \"119.82\",\n \"total_net\": \"119.81\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.00030000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170826\",\n \"account_id\": \"57\",\n \"service_id\": \"67\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"3.111100\",\n \"total_quantity\": \"3.111100\",\n \"unit_based_subtotal_charge\": \"7.78\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"7.78\",\n \"total_charge\": \"7.78\",\n \"total_cogs\": \"6.84\",\n \"total_net\": \"0.93\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170826\",\n \"account_id\": \"58\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"3.000000\",\n \"total_quantity\": \"3.000000\",\n \"unit_based_subtotal_charge\": \"7.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"7.50\",\n \"total_charge\": \"7.50\",\n \"total_cogs\": \"6.60\",\n \"total_net\": \"0.90\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170827\",\n \"account_id\": \"56\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"116.000000\",\n \"total_quantity\": \"116.000000\",\n \"unit_based_subtotal_charge\": \"1985.04\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"1985.04\",\n \"total_charge\": \"1985.04\",\n \"total_cogs\": \"1600.80\",\n \"total_net\": \"384.24\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"17.11240000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170827\",\n \"account_id\": \"56\",\n \"service_id\": \"66\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"21.000000\",\n \"total_quantity\": \"21.000000\",\n \"unit_based_subtotal_charge\": \"52.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"52.50\",\n \"total_charge\": \"52.50\",\n \"total_cogs\": \"46.20\",\n \"total_net\": \"6.30\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170827\",\n \"account_id\": \"57\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"120.000000\",\n \"total_quantity\": \"120.000000\",\n \"unit_based_subtotal_charge\": \"240.04\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"240.04\",\n \"total_charge\": \"240.04\",\n \"total_cogs\": \"120.02\",\n \"total_net\": \"120.01\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.00030000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170827\",\n \"account_id\": \"57\",\n \"service_id\": \"67\",\n \"servicecategory_id\": \"47\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"5.111100\",\n \"total_quantity\": \"5.111100\",\n \"unit_based_subtotal_charge\": \"12.78\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"12.78\",\n \"total_charge\": \"12.78\",\n \"total_cogs\": \"11.24\",\n \"total_net\": \"1.53\",\n \"min_commit_delta_quantity\": \"0.000000\",\n \"min_commit_delta_charge\": \"0.00\",\n \"adjustments\": [],\n \"tier_breakdown\": [],\n \"avg_unit_based_rate\": \"2.50000000\",\n \"avg_interval_based_rate\": \"0.00000000\",\n \"breakdown\": null,\n \"day\": \"20170827\",\n \"account_id\": \"58\",\n \"service_id\": \"64\",\n \"servicecategory_id\": \"46\"\n }\n ]\n }\n}"}],"_postman_id":"60541713-c4f0-4a85-a5a1-10338b67217b"},{"name":"Get report resources","event":[{"listen":"test","script":{"id":"841e3663-d637-48a9-a9fd-190c5aa737a9","exec":["// pm.test(\"Status code is 200\", function () {","// pm.response.to.have.status(200);","// });","","// let response = pm.response.text();","","// for (let i of responseBody.split('\\n')) {","// if (i[0] === '{') {","// response = JSON.parse(i);","// }","// }","","// pm.test(\"Response contains report\", function () {","// pm.expect(response.report).to.be.an('array');","// pm.expect(response.report[0]).to.be.an('object');","// pm.expect(response.report[0].meta).to.be.an('object');","// pm.expect(response.report[0].error).to.be.a('boolean');","// pm.expect(response.report[0].error).to.eql(false);","// pm.expect(response.report[0].data).to.be.an('array');","// });"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"bba01f85-11bb-41e3-9ee5-482c87006de7","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.requireReportDefinition)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"beb2157f-50f2-460f-9e73-a870119f9b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/reportdata/:reportdefinition_id/resources?start={{start}}&end={{end}}&dimension=&depth=&filter[field]","description":"β οΈ This endpoints are currently in alpha and may change at any time. Please don't use in production.
\n","urlObject":{"path":["v2","reportdata",":reportdefinition_id","resources"],"host":["{{base_url}}"],"query":[{"description":{"content":"The start of the date range (inclusive) you want to run the report for in yyyy-mm-dd format. Defaults to the current date.
The end of the date range (inclusive) you want to run the report for in yyyy-mm-dd format. Defaults to the current date.
The dimension you want to include in the output. One of accounts, services or instances (or a combination of those as a comma separated list). Defaults to accounts,services.
The depth in the report definition you want to report on. Defaults to 1.
\n","type":"text/plain"},"key":"depth","value":""},{"description":{"content":"Optionally filter the output by the supplied field. Possible fields are account_id, parent_account_id, service_id, servicecategory_id, instance. This parameter can occur multiple times in a request to filter by multiple fields.
Include additional related resources. Possible values: dataset, 'report'.
Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: services, adjustments, budgetitems.
Atomic support: βοΈ
\nCategories services can be grouped under. A category can contain multiple services, but each service can only be in one category.
\nExamples of categories: Software, Web services
The following relationships can be included:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6f50f330-1c27-46a8-aea9-0905b49c5b32","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f80cf94e-2692-4ac3-a849-78e0eb22aa92","type":"text/javascript","exec":[""]}}],"_postman_id":"6f916e9a-3a8a-4ab2-af7d-670545e73be4"},{"name":"/services","item":[{"name":"Retrieve a list of services","event":[{"listen":"test","script":{"id":"74604837-55e4-43b3-842a-d19fa4e56767","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","// Check response","const response = pm.response.json();","console.log(response);","pm.test(\"Response contains data\", function () {"," pm.response.to.be.json;"," pm.expect(response.data).to.be.an('array');","});","","// Check first service","var service = response.data[0];","pm.test(\"Service type is correct\", function () {"," pm.expect(service.type).to.eql('service');","});","pm.test(\"Service ID is set\", function () {"," pm.expect(service.id).to.not.be.undefined;","});","pm.test(\"Service attributes are correct\", function () {"," pm.expect(service.attributes).to.be.an('object');"," pm.expect(service.attributes).to.have.property(\"key\");"," pm.expect(service.attributes).to.have.property(\"description\");"," pm.expect(service.attributes).to.have.property(\"unit_label\");"," pm.expect(service.attributes).to.have.property(\"dset\");"," pm.expect(service.attributes).to.have.property(\"type\");"," pm.expect(service.attributes).to.have.property(\"usage_col\");"," pm.expect(service.attributes).to.have.property(\"consumption_col\");"," pm.expect(service.attributes).to.have.property(\"instance_col\");"," pm.expect(service.attributes).to.have.property(\"interval\");"," pm.expect(service.attributes).to.have.property(\"charge_type\");"," pm.expect(service.attributes).to.have.property(\"cogs_type\");"," pm.expect(service.attributes).to.have.property(\"proration_type\");"," pm.expect(service.attributes).to.have.property(\"created_at\");"," pm.expect(service.attributes).to.have.property(\"updated_at\");"," pm.expect(service.attributes).to.have.property(\"seen_at\");"," pm.expect(service.attributes).to.have.property(\"orphan\");"," pm.expect(service.attributes).to.have.property(\"charge_model\");","","});","","pm.environment.set('first_service_id', response.data[0].id);","console.log('SET first_service_id: ' + pm.environment.get(\"first_service_id\"));"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f583d34d-4305-4ad4-b406-2fe7c6376906","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}}],"id":"4459c66d-970f-4854-9b9b-591bc523079f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/services?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","services"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: servicecategory, rates, adjustments, dataset, metadata, budgetitems.
Include additional related resources. Possible values: servicecategory, rates, adjustments, dataset, metadata.
Atomic support: βοΈ
\nServices can be anything that is a sellable item, that can be consumed. And should relate to (extracted) consumption data.
\nExivtiy documentation: https://docs.exivity.com/architecture%20concepts/glossary/#service
\nThe following resources can be included:
\nThe attributes charge_type and cogs_type define how the rate is used when calculating charge and cogs metrics using consumption of the service.
The first part denotes whether the rate is dynamically derived from the usage data itself (automatic) or specified explicitly in rate entities (manual).
The second part denotes whether an amount per unit of consumption (per_unit) and/or per interval (per_interval) should be applied.
When the second part is omitted, both per_unit and per_interval are used. If no rate should be applied at all, none can be used. A value of other means a configuration is used not currently supported by the API.
Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: account, service.
Include additional related resources. Possible values: account, service.
Atomic support: βοΈ
\nSubscriptions enable users to manage one-off and recurring transactions for charging non-metered services. Read more.
\nThe following resources can be included:
\n","event":[{"listen":"prerequest","script":{"id":"957b1520-3a96-47a3-9d6e-a20beb6e82f2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9ccb5aab-6cec-4325-82e3-05901795c921","type":"text/javascript","exec":[""]}}],"_postman_id":"2412d578-cb70-4cb1-b8ef-8c59b1eb0fd9","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","name":"Services","type":"folder"}}},{"name":"/rates","item":[{"name":"Retrieve a list of rates","event":[{"listen":"test","script":{"id":"0c44d117-e22d-4884-83ca-d8850ffe1cfd","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","// Check response","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.response.to.be.json;"," pm.expect(response.data).to.be.an('array');","});","","// Check first rate","var rate = response.data[0];","pm.test(\"Rate type is correct\", function () {"," pm.expect(rate.type).to.eql('rate');","});","pm.test(\"Rate ID is set\", function () {"," pm.expect(rate.id).to.not.be.undefined;","});","pm.test(\"Rate attributes are correct\", function () {"," pm.expect(rate.attributes).to.be.an('object');"," pm.expect(rate.attributes).to.have.property(\"rate\");"," pm.expect(rate.attributes).to.have.property(\"rate_col\");"," pm.expect(rate.attributes).to.have.property(\"threshold\");"," pm.expect(rate.attributes).to.have.property(\"min_commit\");"," pm.expect(rate.attributes).to.have.property(\"effective_date\");"," pm.expect(rate.attributes).to.have.property(\"fixed\");"," pm.expect(rate.attributes).to.have.property(\"fixed_col\");"," pm.expect(rate.attributes).to.have.property(\"cogs_rate\");"," pm.expect(rate.attributes).to.have.property(\"cogs_rate_col\");"," pm.expect(rate.attributes).to.have.property(\"cogs_fixed\");"," pm.expect(rate.attributes).to.have.property(\"cogs_fixed_col\");","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"cdb7f094-adba-4e1f-a35c-f29e46990b7b","exec":["const api = eval(pm.globals.get('exivity'))();","","api.start()"," .then(api.requireToken)"," .then(api.ready)"," .catch(function(err) {"," console.log(err);"," });",""],"type":"text/javascript"}}],"id":"3263150c-1a80-4e5b-a2b5-cac7e8ee227c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/rates?page[limit]&page[offset]&sort&filter[attribute]&include","urlObject":{"path":["v2","rates"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: service, account, ratetiers.
Account specific rates can be created through this endpoint by specifying the account relationship in the request body, e.g.:
\"relationships\": {\n \"service\": { ... },\n \"account\": {\n \"data\": {\n \"type\": \"account\",\n \"id\": \"1\"\n }\n }\n}\nInclude additional related resources. Possible values: service, account, ratetiers
A rate that has the earliest effective_date from the perspective of the associated service cannot be deleted.
Atomic support: βοΈ
\nRates allows you to configure charge/cogs rates either manually or automatically.
\nExivity documentation: https://docs.exivity.com/services/rates
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"7de09f58-1052-461e-ba64-01cfaeff652b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0163d2f2-727f-4bc6-bac1-7feee6ba7987","type":"text/javascript","exec":[""]}}],"_postman_id":"2a078ade-bde3-494a-9674-c37ed0ce980a","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","name":"Services","type":"folder"}}},{"name":"/ratetiers","item":[{"name":"Retrieve a list of rate tiers","event":[{"listen":"test","script":{"id":"7db21121-838e-49b5-be47-b6a936f0f5ab","exec":["/*pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","// Check response","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.response.to.be.json;"," pm.expect(response.data).to.be.an('array');","});","","// Check first rate tier","var ratetier = response.data[0];","pm.test(\"Ratetier type is correct\", function () {"," pm.expect(ratetier.type).to.eql('ratetier');","});","pm.test(\"Ratetier ID is set\", function () {"," pm.expect(ratetier.id).to.not.be.undefined;","});","pm.test(\"Ratetier attributes are correct\", function () {"," pm.expect(ratetier.attributes).to.be.an('object');"," pm.expect(ratetier.attributes).to.have.property(\"threshold\");"," pm.expect(ratetier.attributes).to.have.property(\"rate\");"," pm.expect(ratetier.attributes).to.have.property(\"cogs\");","});*/"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c76f2b87-4475-4ea9-ae19-81810c7c1c2d","exec":["const api = eval(pm.globals.get('exivity'))();","","api.start()"," .then(api.requireToken)"," .then(api.ready)"," .catch(function(err) {"," console.log(err);"," });",""],"type":"text/javascript"}}],"id":"82bb2528-34da-4e55-8917-00ae447c8a30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/ratetiers?page[limit]&page[offset]&sort&filter[attribute]&include","urlObject":{"path":["v2","ratetiers"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: rate.
Include additional related resources. Possible values: rate.
Atomic support: βοΈ
\nRate tiers allows you to configure tiered pricing.
Exivity documentation: https://docs.exivity.com/services/rates
The following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"53dd7c15-cb40-4964-a120-6fad299c55ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce86bef1-6dd9-4fce-a9ed-02912cda3c17","type":"text/javascript","exec":[""]}}],"_postman_id":"6b47a562-76eb-4b95-8c7f-60d6e6f7c5b4","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","name":"Services","type":"folder"}}},{"name":"/adjustments","item":[{"name":"Retrieve a list of adjustments","event":[{"listen":"test","script":{"id":"bdb8eb43-49bb-4f55-9d0f-de32343122a5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"f9596d71-856f-495d-a7b0-6f70c74b8b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/adjustments?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","adjustments"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: account, services, servicecategories.
Include additional related resources
\n","type":"text/plain"},"key":"include","value":null}],"variable":[{"id":"d5eef3ba-0e40-4873-9043-188dea99b6a2","type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[{"id":"244e82d6-f3e1-490e-90ce-98117f6d7e8a","name":"Retrieve an adjustment","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/adjustments/:adjustment_id?include","host":["{{base_url}}"],"path":["v2","adjustments",":adjustment_id"],"query":[{"key":"include","value":null,"description":"Include additional related resources"}],"variable":[{"id":"d5eef3ba-0e40-4873-9043-188dea99b6a2","key":"adjustment_id","value":"{{adjustment_id}}","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 23 May 2022 08:01:56 GMT"},{"key":"Date","value":"Mon, 23 May 2022 08:01:56 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xe1ea472790e5e4c05235a66b75182aea"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-szJEH7fIAFw6FKxeIh3KKlLr9V8IWJMs';style-src 'self' 'nonce-szJEH7fIAFw6FKxeIh3KKlLr9V8IWJMs';font-src 'self' data:"},{"key":"Request-Id","value":"daa0ab4a-b29c-4929-b667-32d15fdcf9fc"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"test\",\n \"amount\": -10,\n \"sort\": 0,\n \"type\": \"relative\",\n \"target\": \"charge\",\n \"first_interval\": \"2017-01\",\n \"last_interval\": \"2017-12\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1\"\n },\n \"relationships\": {\n \"account\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/account\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/account\"\n }\n },\n \"services\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/services\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/services\"\n }\n },\n \"servicecategories\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/servicecategories\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/servicecategories\"\n }\n }\n }\n }\n}"}],"_postman_id":"9e4aca3c-9991-42ee-97fc-c5991fe044c0"},{"name":"Update an adjustment","event":[{"listen":"test","script":{"id":"bd7013e5-ea19-4262-ba53-7a95d03a0c53","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('adjustment');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"adjustment_id\").toString());","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes.name).to.eql('modified_test');"," pm.expect(response.data.attributes.amount).to.eql(-20);"," pm.expect(response.data.attributes.type).to.eql('absolute');"," pm.expect(response.data.attributes.target).to.eql('quantity');"," pm.expect(response.data.attributes.first_interval).to.eql('2018-01');"," pm.expect(response.data.attributes.last_interval).to.eql(null);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"7b794967-6be2-4e28-afd8-1535fefb588c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"adjustment\",\r\n \"id\": \"{{adjustment_id}}\",\r\n \"attributes\": {\r\n \"name\": \"modified_test\",\r\n \"amount\": \"-20\",\r\n \"type\": \"absolute\",\r\n \"target\": \"quantity\",\r\n \"first_interval\": \"2018-01\",\r\n \"last_interval\": \"\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/adjustments/:adjustment_id","urlObject":{"path":["v2","adjustments",":adjustment_id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"12392cc9-1206-4e56-8008-838a68479cfe","type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[{"id":"b1ac1b6f-0f8a-4c23-b203-b7b1235bbb9a","name":"Update an adjustment","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"adjustment\",\r\n \"id\": \"{{adjustment_id}}\",\r\n \"attributes\": {\r\n \"name\": \"modified_test\",\r\n \"amount\": \"-20\",\r\n \"type\": \"absolute\",\r\n \"target\": \"quantity\",\r\n \"first_interval\": \"2018-01\",\r\n \"last_interval\": \"\"\r\n }\r\n }\r\n}"},"url":{"raw":"{{base_url}}/v2/adjustments/:adjustment_id","host":["{{base_url}}"],"path":["v2","adjustments",":adjustment_id"],"variable":[{"id":"12392cc9-1206-4e56-8008-838a68479cfe","key":"adjustment_id","value":"{{adjustment_id}}","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 23 May 2022 08:02:21 GMT"},{"key":"Date","value":"Mon, 23 May 2022 08:02:21 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X7e0c90315c0ac61975de2c7c2127ad28"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-Z3mRND9S7omXxWHNvyM4NITlKCy8j4Qs';style-src 'self' 'nonce-Z3mRND9S7omXxWHNvyM4NITlKCy8j4Qs';font-src 'self' data:"},{"key":"Request-Id","value":"8c2415f5-c109-4965-b42b-8526f05809b3"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"modified_test\",\n \"amount\": -20,\n \"sort\": 0,\n \"type\": \"absolute\",\n \"target\": \"quantity\",\n \"first_interval\": \"2018-01\",\n \"last_interval\": null\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1\"\n },\n \"relationships\": {\n \"account\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/account\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/account\"\n }\n },\n \"services\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/services\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/services\"\n }\n },\n \"servicecategories\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/adjustments/1/relationships/servicecategories\",\n \"related\": \"http://localhost:8012/v2/adjustments/1/servicecategories\"\n }\n }\n }\n }\n}"}],"_postman_id":"7b794967-6be2-4e28-afd8-1535fefb588c"},{"name":"Prepare affected reports","event":[{"listen":"test","script":{"id":"09e0f439-f8e6-434a-8baf-39d746bb54df","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","console.log(pm.response);"],"type":"text/javascript"}}],"id":"7556466f-11b2-4878-b493-30d544feb0a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/adjustments/:adjustment_id/prepareAffectedReports","description":"Atomic support: β
\nThe preparation of a report populates the accounts table and also optimizes the performance when running your reports. When adjustments change, it is a good idea to run this command to update any effected data.
\n","urlObject":{"path":["v2","adjustments",":adjustment_id","prepareAffectedReports"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"integer
\n","type":"text/plain"},"type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[],"_postman_id":"7556466f-11b2-4878-b493-30d544feb0a5"},{"name":"Delete an adjustment","event":[{"listen":"test","script":{"id":"6c295712-93cb-4756-9ed8-d87049b13bd1","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET adjustment_id');","pm.environment.unset(\"adjustment_id\");"],"type":"text/javascript"}}],"id":"e920db17-53eb-4348-8007-c0e0b9eadccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/adjustments/:adjustment_id","urlObject":{"path":["v2","adjustments",":adjustment_id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"7b8902f4-e769-4f5c-afda-ee87b7704bb9","type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[],"_postman_id":"e920db17-53eb-4348-8007-c0e0b9eadccf"}],"id":"6502a1f9-51c5-4abe-8b2a-136b12981d5b","description":"Atomic support: βοΈ
\nAdjustments allow a user to create account-specific rate adjustment policies.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#adjustment
\nThe following resources can be included:
\n","event":[{"listen":"prerequest","script":{"id":"fd5daae5-1e39-4671-88ef-570dc823e48d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c6b31c0-b30d-4a7c-8cf9-b02cd72e26e4","type":"text/javascript","exec":[""]}}],"_postman_id":"6502a1f9-51c5-4abe-8b2a-136b12981d5b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","name":"Services","type":"folder"}}}],"id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ad7bf846-93f1-4315-b049-143c5ff035b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3d204ec-5ea8-4eb2-b539-4788fb0f79f7","type":"text/javascript","exec":[""]}}],"_postman_id":"a63d8d5c-7ba8-4b44-8400-b2cc8123456e","description":""},{"name":"Accounts","item":[{"name":"/accounts","item":[{"name":"Retrieve a list of accounts","event":[{"listen":"test","script":{"id":"ad745176-74eb-438f-b682-33d32c39a648","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});","","pm.environment.set(\"account_id\", response.data[0].id);","console.log('SET account_id: ' + pm.environment.get(\"account_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"dd318e88-dc53-4a01-a5ed-5676d7953fd1","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"26443a67-def1-4270-80e8-1c00f8b88af2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/accounts?page[limit]&page[offset]&sort&filter[name]=&include=","urlObject":{"path":["v2","accounts"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: report, parent, children, rates, adjustments, users, metadata, budgetitems, servicesubscriptions.
Atomic support: βοΈ
\nExivity documentation: https://docs.exivity.com/reports/accounts
\nThe following relationships can be included:
\n","_postman_id":"71379876-4e58-479f-92ed-20ebf15a786c"},{"name":"/budgets","item":[{"name":"Retrieve a list of budgets","event":[{"listen":"test","script":{"id":"280b918d-0cb7-4e44-82e6-7114cd587cb5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"992a6681-0ffe-4560-aa0c-df7ece916b9d","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}}],"id":"b82c6e6d-e662-46dd-9806-8f5b189638ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/budgets?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","budgets"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: report, revisions.
Include additional related resources: revisions
Atomic support: βοΈ
\nExivity documentation: https://docs.exivity.com/reports/budget
\nTo create a budget
\nThe following relationships can be included:
\n","_postman_id":"081d8203-8048-4728-8752-da56b1eb37d3"},{"name":"/budgetrevisions","item":[{"name":"Retrieve a list of budgets revisions","event":[{"listen":"test","script":{"id":"9eaec45c-1777-44a1-ab92-e1c2fb9783fb","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"0229c74c-f056-466e-838c-aab77f79d0d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/budgetrevisions?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","budgetrevisions"],"host":["{{base_url}}"],"query":[{"key":"page[limit]","value":null},{"key":"page[offset]","value":null},{"key":"sort","value":null},{"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: budget, items
Include additional related resources. Possible values: budget, items
Atomic support: βοΈ
\nExivity documentation: https://docs.exivity.com/reports/budget
\nThe following relationships can be included:
\n","_postman_id":"438b6fda-f3b9-406f-83f8-74a2f7cef410"},{"name":"/budgetitems","item":[{"name":"Retrieve a list of budgets items","event":[{"listen":"test","script":{"id":"bf4d1e96-4d1c-4dc8-8a9f-02ad6a81bc7a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"7d5fe99d-5cdb-40b0-bacd-c0c87241ddf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/budgetitems?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","budgetitems"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: revision, parent, children, account, services, servicecategories
Include additional related resources. Possible values: revision, parent, children, account, services, servicecategories
Atomic support: βοΈ
\nExivity documentation: https://docs.exivity.com/reports/budget
\nThe following relationships can be included:
\n","_postman_id":"d5bb095c-3053-4b8c-87be-97e0c364f289"}],"id":"497d81a9-1b1e-4d1d-aa2d-21ac3dd572fb","_postman_id":"497d81a9-1b1e-4d1d-aa2d-21ac3dd572fb","description":""},{"name":"Data pipelines","item":[{"name":"/extractors","item":[{"name":"Retrieve a list of extractors","event":[{"listen":"test","script":{"id":"a5321961-76d3-4668-8e67-625cd30e4760","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"515ed917-091a-4329-8e70-425d62ed8c99","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"4c1b13ae-cbd0-4edd-89d1-f4db54334335","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/extractors","urlObject":{"path":["v2","extractors"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1ae44909-a9ab-47f6-959e-5c3db49493dd","name":"Retrieve a list of extractors","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/extractors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 03 Dec 2024 09:42:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xb81cb559aa815becec8a2b94938b42e8"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xb81cb559aa815becec8a2b94938b42e8"},{"key":"ETag","value":"\"d7b668c9710182ac6ce06bd182280bfb\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-uDj5sOuZ1PDonfEDaXavfT6MwEs8FX6e';style-src 'self' 'nonce-uDj5sOuZ1PDonfEDaXavfT6MwEs8FX6e';font-src 'self' data:"},{"key":"Request-Id","value":"2c8b8d7c-d740-46c8-94a5-9c26931626c5"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"extractor\",\n \"id\": \"Extractor_1\",\n \"attributes\": {\n \"name\": \"Extractor_1\",\n \"contents\": \"print Hello\\nvar key1 = value1\\npublic var key2 = value2\\npublic encrypted var key3 = FeBtNpkfbyD4ePKU+EXOwQ==\",\n \"variables\": [\n {\n \"name\": \"key2\",\n \"value\": \"value2\",\n \"type\": \"normal\",\n \"line\": 3,\n \"comment\": \"\"\n },\n {\n \"name\": \"key3\",\n \"value\": \"Environment ID (optional)
\n","type":"text/plain"},"key":"environment_id","value":""},{"key":"arguments","value":null}],"variable":[{"type":"any","value":"{{extractor_name}}","key":"extractor_id"}]}},"response":[{"id":"088e3379-b033-4817-8447-a18fbd91458b","name":"Run an extractor","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/v2/extractors/:extractor_id/run?arguments","host":["{{base_url}}"],"path":["v2","extractors",":extractor_id","run"],"query":[{"key":"environment_id","value":"","description":"Environment ID (optional)","disabled":true},{"key":"arguments","value":null}],"variable":[{"key":"extractor_id","value":"{{extractor_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 03 Dec 2024 10:01:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xbf2f098a9f66c6eb7d5b7222b8bd1622"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xbf2f098a9f66c6eb7d5b7222b8bd1622"},{"key":"ETag","value":"\"19f3b471e47ce1140e5a7ff0701268c0\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-EBbA4IXHyP03dWssIoxbDRC0QzsInGss';style-src 'self' 'nonce-EBbA4IXHyP03dWssIoxbDRC0QzsInGss';font-src 'self' data:"},{"key":"Request-Id","value":"fd7fc6ce-f5cf-4acb-89a2-9ee4284017c9"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"extractor\",\n \"id\": \"MyExtractor\",\n \"attributes\": {\n \"name\": \"MyExtractor\",\n \"contents\": \"print Hello\\nvar key1 = value1\\npublic var key2 = \\\"value2\\\"\\npublic var key3 = \\\"value3\\\"\",\n \"variables\": [\n {\n \"name\": \"key2\",\n \"value\": \"value2\",\n \"type\": \"normal\",\n \"line\": 3,\n \"comment\": \"\"\n },\n {\n \"name\": \"key3\",\n \"value\": \"value3\",\n \"type\": \"normal\",\n \"line\": 4,\n \"comment\": \"\"\n }\n ],\n \"updated_at\": \"2024-12-03T10:01:08Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/extractors/MyExtractor\"\n }\n },\n \"meta\": [\n \"=================================\\r\\nUSE: Unified Scriptable Extractor\\r\\n=================================\\r\\nHello \\r\\n\\r\\nUSE script finished successfully\\r\\n\"\n ]\n}"}],"_postman_id":"8717d460-5cf8-4091-9716-99ad2084f3be"},{"name":"Delete an extractor","event":[{"listen":"test","script":{"id":"1baa50dc-5538-4fc9-9b43-037b587261d2","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET extractor_name');","pm.environment.unset(\"extractor_name\");","","postman.clearEnvironmentVariable(\"extractor_name\");",""],"type":"text/javascript"}}],"id":"6bbcd641-73e1-4bc7-b01c-cf1ac10ab421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/extractors/:extractor_id","urlObject":{"path":["v2","extractors",":extractor_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{extractor_name}}","key":"extractor_id"}]}},"response":[{"id":"19dc20fc-44e4-4c9a-9ecf-8cb3666c0fb2","name":"Delete an extractor","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/extractors/:extractor_id","host":["{{base_url}}"],"path":["v2","extractors",":extractor_id"],"variable":[{"key":"extractor_id","value":"{{extractor_name}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 03 Dec 2024 09:41:02 GMT"},{"key":"X-Clockwork-Id","value":"X5c6b79cfc8fc2971d9a977e4f993a0c0"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X5c6b79cfc8fc2971d9a977e4f993a0c0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-yOmZuxMp7g0YzAm9mWBx1uDhuB99BuIv';style-src 'self' 'nonce-yOmZuxMp7g0YzAm9mWBx1uDhuB99BuIv';font-src 'self' data:"},{"key":"Request-Id","value":"0408a3a4-d9b9-41ea-8ad4-df2c4110904f"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6bbcd641-73e1-4bc7-b01c-cf1ac10ab421"}],"id":"d8debe93-80ca-4f36-add8-40628180362d","description":"β‘ Not JSON:API compliant
\nAtomic support: β
\nExtraction is the process by which USE (Unified Scriptable Extractor) retrieves data from external locations. Read more.
\nThe following resources can be included:
\n","event":[{"listen":"prerequest","script":{"id":"0a642fd4-1bf3-46ad-ad32-e69435db5f7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4c4fd39b-2a07-47cd-bfb0-b9d0144adaec","type":"text/javascript","exec":[""]}}],"_postman_id":"d8debe93-80ca-4f36-add8-40628180362d"},{"name":"/transformers","item":[{"name":"Retrieve a list of transformers","event":[{"listen":"test","script":{"id":"341d29ca-c26d-4fac-98e5-b95ed5702bd6","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('array');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2382f323-6b67-47c3-b3e0-b5d65b738e11","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"0e115c50-618f-49f9-bc4d-2ec25bb007f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/transformers","urlObject":{"path":["v2","transformers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"52e45d3f-aa4c-4c0a-b9ef-ef64db6640dd","name":"Retrieve a list of transformers","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/transformers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 13 Jan 2025 11:22:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xb1a821e6b0e888058dfaff7aedbe024e"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xb1a821e6b0e888058dfaff7aedbe024e"},{"key":"ETag","value":"\"fe9e9d1bf275e690125705d437f94ac2\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-PindEiV0tC9H8ZkgHHoRULylywD02ppt';style-src 'self' 'nonce-PindEiV0tC9H8ZkgHHoRULylywD02ppt';font-src 'self' data:"},{"key":"Request-Id","value":"8c499ddf-d405-4985-bf83-831fad0c2a09"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"transformer\",\n \"id\": \"Transformer_test_918\",\n \"attributes\": {\n \"name\": \"Transformer_test_918\",\n \"contents\": \"script here\",\n \"updated_at\": \"2025-01-13T11:20:32Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/transformers/Transformer_test_918\"\n }\n },\n {\n \"type\": \"transformer\",\n \"id\": \"test\",\n \"attributes\": {\n \"name\": \"test\",\n \"contents\": \"# usage data\\r\\nimport usage from test\\r\\noption services = overwrite\\r\\nfinish\\r\\n\\r\\noption services = overwrite\\r\\n\\r\\nservices {\\r\\n service_type = automatic\\r\\n description_col = description\\r\\n category_col = category\\r\\n instance_col = UniqueID\\r\\n usages_col = service_name\\r\\n rate_col = rate\\r\\n cogs_col = cogs\\r\\n interval_col = interval\\r\\n model_col = model\\r\\n unit_label_col = unit\\r\\n consumption_col = quantity\\r\\n}\\r\\n\",\n \"updated_at\": \"2024-12-19T13:47:08Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/transformers/test\"\n }\n }\n ]\n}"}],"_postman_id":"0e115c50-618f-49f9-bc4d-2ec25bb007f2"},{"name":"Add a new transformer","event":[{"listen":"test","script":{"id":"095f61cb-1f26-40dc-9d9c-0e922b9ad28f","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('object');","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.name).to.be.a('string');"," pm.expect(response.contents).to.be.a('string');"," pm.expect(response.hash).to.be.a('string');"," pm.expect(response.last_modified).to.be.a('string');",""," pm.expect(response.name).to.include('Transformer_test');"," pm.expect(response.contents.trim()).to.eql('# script here');","});","","pm.environment.set(\"transformer_name\", response.name);","console.log('SET transformer_name: ' + pm.environment.get(\"transformer_name\"));"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"8b49ac2c-6034-4a67-bac0-bf6be4d71685","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript","packages":{}}}],"id":"1b9454ac-46f6-4f30-af55-032263e63d0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n \"type\":\"transformer\",\r\n \"attributes\": {\r\n \"name\": \"Transformer test 715\",\r\n \"contents\": \"# script here\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/transformers","urlObject":{"path":["v2","transformers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7d6d96c3-4f1d-4698-b2bf-88e893c5cfdb","name":"Add a new transformer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n \"type\":\"transformer\",\r\n \"attributes\": {\r\n \"name\": \"Transformer test 606\",\r\n \"contents\": \"# script here\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/transformers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 13 Jan 2025 11:21:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xe3f114907d4a8ac4e8a6b4dc87e56ae0"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xe3f114907d4a8ac4e8a6b4dc87e56ae0"},{"key":"ETag","value":"\"fc7f6dd41486e8d8f0c42881ca9f5fa1\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-LSxePVDO5yaGhOOlmIo3SXtyfKQn0qpR';style-src 'self' 'nonce-LSxePVDO5yaGhOOlmIo3SXtyfKQn0qpR';font-src 'self' data:"},{"key":"Request-Id","value":"8939c99c-186b-4c0b-9bdf-1083afc1547e"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"transformer\",\n \"id\": \"Transformer_test_905\",\n \"attributes\": {\n \"name\": \"Transformer_test_905\",\n \"contents\": \"# script here\",\n \"updated_at\": \"2025-01-13T11:21:04Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/transformers/Transformer_test_905\"\n }\n }\n}"}],"_postman_id":"1b9454ac-46f6-4f30-af55-032263e63d0f"},{"name":"Retrieve a transformer","event":[{"listen":"test","script":{"id":"c8a7e41a-64db-4421-9ccd-85b730eb44bf","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('object');","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.name).to.be.a('string');"," pm.expect(response.contents).to.be.a('string');"," pm.expect(response.hash).to.be.a('string');"," pm.expect(response.last_modified).to.be.a('string');",""," pm.expect(response.name).to.eql(pm.environment.get(\"transformer_name\"));"," pm.expect(response.contents.trim()).to.eql('# script here');","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c86b02fb-2532-45ab-af74-fe31f8c1f090","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"49a45a4f-8ac4-43e1-aa0a-3cfffc507333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/transformers/:transformer_id","urlObject":{"path":["v2","transformers",":transformer_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transformer_name}}","key":"transformer_id"}]}},"response":[{"id":"dd0c9d72-a1fe-4172-a622-c556e7816237","name":"Retrieve a transformer","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v2/transformers/:transformer_id","host":["{{base_url}}"],"path":["v2","transformers",":transformer_id"],"variable":[{"key":"transformer_id","value":"dummy-transformer"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 20 May 2022 13:23:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-s1cwKn42BEWtgJHwBCNzS7uCInoyqphW';style-src 'self' 'nonce-s1cwKn42BEWtgJHwBCNzS7uCInoyqphW';font-src 'self' data:"},{"key":"Request-Id","value":"f073f406-f8ac-4a29-9ab1-009347a9cee9"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"transformer\",\n \"id\": \"dummy-transformer\",\n \"attributes\": {\n \"name\": \"dummy-transformer\",\n \"contents\": \"import system/extracted/${dataYear}/${dataMonth}/${dataDay}_usage.csv source dummy-data alias dummy-usage\\nfinish\\n\\nservices {\\n usages_col = service_name\\n service_type = automatic\\n description_col = service_name\\n category_col = category\\n instance_col = UniqueID\\n model_col = model\\n rate_col = rate\\n cogs_col = cogs\\n interval_col = interval\\n unit_label_col = unit\\n consumption_col = quantity\\n}\",\n \"hash\": \"0728ca8e495f9775ec42aa2aa4ba326dedeb5706\",\n \"last_modified\": \"2022-05-17T16:28:04Z\"\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/transformers/dummy-transformer\"\n }\n }\n}"}],"_postman_id":"49a45a4f-8ac4-43e1-aa0a-3cfffc507333"},{"name":"Update a transformer","event":[{"listen":"test","script":{"id":"52d8f0e0-c0b8-4288-9b1f-5b7b8c612762","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('object');","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.name).to.be.a('string');"," pm.expect(response.contents).to.be.a('string');"," pm.expect(response.hash).to.be.a('string');"," pm.expect(response.last_modified).to.be.a('string');",""," pm.expect(response.name).to.eql(pm.environment.get(\"transformer_name\"));"," pm.expect(response.contents.trim()).to.eql('# modified script here');","});"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"cbe8d02e-7ff0-4512-87b7-82d562dda306","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript","packages":{}}}],"id":"b49dfb4f-b738-4de0-a277-beb5a8978980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n \"type\":\"transformer\",\r\n \"id\": \"{{transformer_name}}\",\r\n \"attributes\": {\r\n \"contents\": \"my new script\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/transformers/:transformer_id","urlObject":{"path":["v2","transformers",":transformer_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transformer_name}}","key":"transformer_id"}]}},"response":[{"id":"ac2f0bb0-02b6-45de-8eeb-8d562d8b2734","name":"Update a transformer","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n \"type\":\"transformer\",\r\n \"id\": \"{{transformer_name}}\",\r\n \"attributes\": {\r\n \"contents\": \"my new script\"\r\n }\r\n }\r\n}"},"url":{"raw":"{{base_url}}/v2/transformers/:transformer_id","host":["{{base_url}}"],"path":["v2","transformers",":transformer_id"],"variable":[{"key":"transformer_id","value":"{{transformer_name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 13 Jan 2025 11:28:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xdfa74fde92cbd3a399d332887cdbbaf2"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xdfa74fde92cbd3a399d332887cdbbaf2"},{"key":"ETag","value":"\"f10ea2c6cc4fad6038acdf4e0923f1b1\""},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-0VNFncPG8rrEwr7RFVWM46pxYgZBpSBP';style-src 'self' 'nonce-0VNFncPG8rrEwr7RFVWM46pxYgZBpSBP';font-src 'self' data:"},{"key":"Request-Id","value":"74f9cc56-cdde-40c0-b44b-91dd76682558"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"transformer\",\n \"id\": \"Transformer_test_918\",\n \"attributes\": {\n \"name\": \"Transformer_test_918\",\n \"contents\": \"my new script\",\n \"updated_at\": \"2025-01-13T11:28:15Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/transformers/Transformer_test_918\"\n }\n }\n}"}],"_postman_id":"b49dfb4f-b738-4de0-a277-beb5a8978980"},{"name":"Run a transformer","event":[{"listen":"test","script":{"id":"c720e70b-97bf-4697-bb17-0ced8598549d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","console.log(pm.response);","let response = pm.response.text();","","for (let i of responseBody.split('\\n')) {"," if (i[0] === '{') {"," response = JSON.parse(i);"," }","}","","pm.test(\"Response contains output\", function () {"," pm.expect(response).to.be.an('object');"," pm.expect(response.status).to.be.a('string');"," pm.expect(response.start_time).to.be.a('string');"," pm.expect(response.end_time).to.be.a('string');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2135eb50-4fef-477d-8a2d-4ba06464d2d0","exec":["pm.environment.set(\"date\", \"20170101\");","","const api = eval(pm.globals.get('exivity'))();","api.start()"," .then(api.requireToken)"," .then(api.ready)"," .catch(function(err) {"," console.log(err);"," });"],"type":"text/javascript"}}],"id":"31d6f171-5470-4d7a-bad0-915f6cfc8927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/transformers/:transformer_id/run?date={{date}}&start_date=&end_date=&limit&break_at&preview=&snapshot_deset&environment_id","urlObject":{"path":["v2","transformers",":transformer_id","run"],"host":["{{base_url}}"],"query":[{"description":{"content":"Date to run the fransformer for (in YYYY-MM-DD format).
If the transformer should be run for a range of dates, the start date to run the fransformer for (in YYYY-MM-DD format).
If the transformer should be run for a range of dates, the end date to run the fransformer for (in YYYY-MM-DD format).
Limit the number of records to preview, defaults to 10.
When in preview mode, stop executing the transformer before this line.
\n","type":"text/plain"},"key":"break_at","value":null},{"description":{"content":"If set to 1, all statements which modify the system will be skipped and the default dataset will be included with the response.
With preview only - name of dset to preview. If not selected, default dset will be used.
\n","type":"text/plain"},"key":"snapshot_deset","value":null},{"description":{"content":"Environment ID (optional)
\n","type":"text/plain"},"key":"environment_id","value":null}],"variable":[{"type":"any","value":"{{transformer_name}}","key":"transformer_id"}]}},"response":[],"_postman_id":"31d6f171-5470-4d7a-bad0-915f6cfc8927"},{"name":"Delete a transformer","event":[{"listen":"test","script":{"id":"4efbebe9-89e9-4852-9444-1c8a1f1e3b6f","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET transformer_name');","pm.environment.unset(\"transformer_name\");"],"type":"text/javascript"}}],"id":"589d3065-09b3-4d1c-a3f2-5a8db5cb3fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v2/transformers/:transformer_id","urlObject":{"path":["v2","transformers",":transformer_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{transformer_name}}","key":"transformer_id"}]}},"response":[{"id":"afd4a63b-8db7-4336-9d72-8eb00dfda2af","name":"Delete a transformer","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v2/transformers/:transformer_id","host":["{{base_url}}"],"path":["v2","transformers",":transformer_id"],"variable":[{"key":"transformer_id","value":"{{transformer_name}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 13 Jan 2025 11:28:52 GMT"},{"key":"X-Clockwork-Id","value":"X21b7fd42b5e7765d7f2ba43a6458ef5b"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X21b7fd42b5e7765d7f2ba43a6458ef5b"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-z5GU2HPoS8UQkWj3qAZQuSfR6stvAmsE';style-src 'self' 'nonce-z5GU2HPoS8UQkWj3qAZQuSfR6stvAmsE';font-src 'self' data:"},{"key":"Request-Id","value":"f14c77fb-a188-4551-b8f9-2e64de61d28e"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"589d3065-09b3-4d1c-a3f2-5a8db5cb3fbc"}],"id":"452fa4be-69a5-4e31-a78b-6684ef8faa47","description":"β‘ Not JSON:API compliant
\nAtomic support: β
\nTransformers are user-definable scripts (termed tasks) used to produce one or more Reporting Database Files (RDFs) from one or more input Dataset files in CSV format. These RDFs are later used by the reporting engine to generate results. Read more.
\nThe following resources can be included:
\n","event":[{"listen":"prerequest","script":{"id":"f2841411-598b-4ad7-b8b9-7d6bef475d36","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c53ccabf-55ba-4ddd-bf3d-7ad55fd40748","type":"text/javascript","exec":[""]}}],"_postman_id":"452fa4be-69a5-4e31-a78b-6684ef8faa47"},{"name":"/datasets","item":[{"name":"Retrieve a list of datasets","event":[{"listen":"test","script":{"id":"722c86c2-a613-4a60-be2b-9b8eead81469","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});","","pm.environment.set(\"dset_id\", response.data[0].id);","console.log('SET dset_id: ' + pm.environment.get(\"dset_id\"));"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c3619c58-adc7-42fe-9303-19b26b733864","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"2526119b-3240-4ee1-bd20-37fdea6dd023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/datasets?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","datasets"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: services, reports, metadatadefinition, datasetdays.
Include additional related resources. Possible values: services, reports, metadatadefinition, datasetdays.
The start of the date range (inclusive) you want to delete from the dataset. If not specified, use the first date of the dataset.
\n","type":"text/plain"},"key":"start","value":"{{start}}"},{"description":{"content":"The end of the date range (inclusive) you want to delete from the dataset. If not specified, use the last date of the dataset.
\n","type":"text/plain"},"key":"end","value":"{{end}}"}],"variable":[{"type":"any","value":"{{dset_id}}","key":"dset_id"}]}},"response":[],"_postman_id":"122a25d0-643b-473a-a926-4423964f38b8"}],"id":"a43da502-2623-4f89-8d8b-46b15334acf6","description":"Atomic support: βοΈ
\nA Dataset is the data once it has been imported by a Transcript task. A Dataset resides in RAM during the Transform phase and, if referenced by a finish statement, is then stored in a database file for long-term use. Read more here and here.
\nMany users will want to include datasetdays, as this contains the information previously held in rdf_detail which has been promoted to actual resource with relationship to dataset.
The following resources can be included:
\n","event":[{"listen":"prerequest","script":{"id":"9bb71052-e660-4456-9cfe-ad2f43a22bc4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c777cd51-30c4-4b96-ae29-f3ebddb0a864","type":"text/javascript","exec":[""]}}],"_postman_id":"a43da502-2623-4f89-8d8b-46b15334acf6"},{"name":"/datasetdays","item":[{"name":"Retrieve a list of datasetdayss","event":[{"listen":"test","script":{"id":"722c86c2-a613-4a60-be2b-9b8eead81469","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});","","pm.environment.set(\"dset_id\", response.data[0].id);","console.log('SET dset_id: ' + pm.environment.get(\"dset_id\"));"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c3619c58-adc7-42fe-9303-19b26b733864","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"b9123b20-1680-4dd2-a68f-f80081643f85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/datasetdays?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","datasetdays"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: dataset`.
\n","type":"text/plain"},"key":"include","value":""}],"variable":[]}},"response":[],"_postman_id":"b9123b20-1680-4dd2-a68f-f80081643f85"},{"name":"Retrieve a datasetday","event":[{"listen":"test","script":{"id":"9668e89c-5270-4c9e-8f9d-3190e70e5553","exec":["console.log('USE dset_id(name): ' + pm.environment.get(\"dset_id\"));","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('dset');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"dset_id\").toString());","});","","// Attributes","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes.earliest_rdf).to.be.a('string');"," pm.expect(response.data.attributes.latest_rdf).to.be.a('string');"," pm.expect(response.data.attributes.ref_count).to.be.a('number');"," pm.expect(response.data.attributes.rdf_detail).to.be.an('array');"," pm.expect(response.data.attributes.columns).to.be.an('array').that.is.not.empty;","});","","pm.test(\"Attribute 'columns' is not empty\", function () {"," pm.expect(response.data.attributes.columns).to.be.an('array').that.is.not.empty;","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"bbcb77c9-6d64-4094-8601-3bdc7c1f00b4","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"6b6b8666-5e37-4fc3-85c9-305af990d291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/datasetdayss/:datasetday_id","urlObject":{"path":["v2","datasetdayss",":datasetday_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{datasetday_id}}","key":"datasetday_id"}]}},"response":[],"_postman_id":"6b6b8666-5e37-4fc3-85c9-305af990d291"}],"id":"d3f10f62-852a-4a64-86b0-bec95106ea10","description":"Datasetdays is a read-only resource. Datasetdays are the objects that contain information on the days on which there is usage data within a specific dataset.
\nThe following resources can be included:
\n","_postman_id":"d3f10f62-852a-4a64-86b0-bec95106ea10"},{"name":"/files","item":[{"name":"Upload a file","event":[{"listen":"test","script":{"id":"8e4a9367-e973-44d6-8a17-62d71c4602bc","exec":["// Only test Unprocessable Entity for now, as we're not actually uploading a file","pm.test(\"Status code is 422\", function () {"," pm.response.to.have.status(422);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains error\", function () {"," pm.expect(response.errors).to.be.an('array');"," pm.expect(response.errors[0]).to.be.an('object');"," pm.expect(response.errors[0].detail).to.be.a('string');"," pm.expect(response.errors[0].detail).to.eql('The file field is required.');","});"],"type":"text/javascript"}}],"id":"b1371ca7-7a8a-4794-bbfd-f5edf60fed86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to be uploaded
\n","type":"text","value":""},{"key":"group","value":"","description":"Optional parameter to specify group (default=generic)
\n","type":"text"},{"key":"date","value":"","description":"Optional parameter to specify date in YYYY-MM-DD format (default=current date)
\n","type":"text"},{"key":"sequence","value":"","description":"Optional parameter to specify sequence (default=1 or auto incrementing if current sequence is already in use)
\n","type":"text"}]},"url":"{{base_url}}/v2/files","description":"Only the following file types are accepted:
\nUploaded files are stored as %EXIVITY_HOME_PATH%/import/[group]/[yyyy]/[mm]/[dd]_uploaded_[sequence].[extension], where sequence is a 3 characters long numberic string with padded zeros (e.g. 001 or 026).
Note: starting with Exivity v3.0.0, this endpoint will no longer include the /import/ prefix in the returned JSON response.
Only the following file types are accepted:
\nUploaded files are stored as %EXIVITY_HOME_PATH%/import/[path], where the path is derived from the request URL. Existing files will be overwritten.
List the files in a given folder
Example:
All files are stored in the %EXIVITY_HOME_PATH%/import folder. So /v1/file/generic would return the files from %EXIVITY_HOME_PATH%/import/generic.
Atomic support: β
\nThis endpoint lets you work with files in the Exivity home directory. Currently, only uploading files is supported.
\n","event":[{"listen":"prerequest","script":{"id":"7d728ab7-5c38-441e-9a19-d12478a7a9da","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"735141de-6722-4b82-aac6-234a8930b42c","type":"text/javascript","exec":[""]}}],"_postman_id":"8f4e1c50-3176-489c-abf3-15679be7d3ea"},{"name":"/metadatadefinition","item":[{"name":"Retrieve a list of metadata definitions","event":[{"listen":"test","script":{"id":"1581d23a-dd95-417f-95a8-1c430064a082","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});",""],"type":"text/javascript"}}],"id":"da33ac59-aae3-47da-8610-f2ad1dc16c76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/metadatadefinitions?page[limit]&page[offset]&sort&filter[name]=&include=","urlObject":{"path":["v2","metadatadefinitions"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: metadata, datasets.
Include additional related resources. Possible values: metadata, datasets.
Atomic support: βοΈ
\nMetadata definitions act as schemas that define the structure and validation rules for metadata. They specify what fields are available, their data types (string, numeric, date, array, etc.), and any validation constraints. Once a metadata definition is created, you can attach metadata instances to accounts or services that conform to that definition's structure.
\nUse cases:
\nStore SAML user groups or roles as arrays
\nTrack custom attributes like cost centers, departments, or tags
\nEnforce data validation with regex patterns or predefined lists
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#metadatadefinition
\nField Object
\nField Types
\nstring - Single string value
list - Single value from a predefined list of options (requires list attribute)
numeric - Numeric value
date - Date value
string_array - Array of strings. Useful for multi-valued attributes like SAML user groups. If a validate regex is provided, it applies to each individual item in the array
Examples
\n// String field with regex validation\n{\n \"name\": \"email\",\n \"type\": \"string\",\n \"validate\": \"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$\"\n}\n// String array field without validation\n{\n \"name\": \"user_groups\",\n \"type\": \"string_array\"\n}\n// String array field with regex validation (each item must match)\n{\n \"name\": \"tags\",\n \"type\": \"string_array\",\n \"validate\": \"^[a-z0-9-]+$\"\n}\n// List field\n{\n \"name\": \"department\",\n \"type\": \"list\",\n \"list\": [\"engineering\", \"sales\", \"marketing\"]\n}\n\nThe following relationships can be included:
\nLimit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":"1"},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: definition, accounts, services.
Include additional related resources. Possible values: definition, accounts, services.
Atomic support: βοΈ
\nMetadata stores custom information attached to accounts or services. Each metadata instance conforms to a metadata definition that specifies its structure and validation rules.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#metadata
\nValues Object Structure
\nThe values object contains key-value pairs based on the metadata definition's fields:
{\n \"values\": {\n \"email\": \"user@example.com\", // string field\n \"department\": \"engineering\", // list field\n \"cost_center\": 12345, // numeric field\n \"start_date\": \"2025-01-15\", // date field\n \"user_groups\": [\"admin\", \"developers\"] // string_array field\n }\n}\n\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"bc9fc6a8-e575-46d9-9671-165b449c4d4c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"01105f66-bcb1-4039-85ee-e018923b7a35","type":"text/javascript","exec":[""]}}],"_postman_id":"96375d10-e315-4cc8-9b87-40e9bc7a7f33"},{"name":"/workflows","item":[{"name":"Retrieve a list of workflows","event":[{"listen":"test","script":{"id":"514afef7-9f21-4db5-b7df-58997729829a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});",""],"type":"text/javascript"}}],"id":"0c09078a-12d1-4404-828f-d0b1997e8118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/workflows?page[limit]=&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","workflows"],"host":["{{base_url}}"],"query":[{"key":"page[limit]","value":""},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: steps, schedules, runs.
Once a workflow has been created and steps have been added, you can now run the workflow. See workflow_runs and workflow_step_logs to view the output of a run.
The date to manually run the workflow for (in YYYY-MM-DD format). Defaults to the current date.
On success, aΒ HTTP 204 No Content success status responseΒ will be returned.
Atomic support: βοΈ
\nExivity documentation:
https://docs.exivity.com/Architecture%20concepts/Glossary#workflow
A workflow allows you to schedule various tasks and execute them at a specific date and time.
\nTo create a workflow
\nThe following relationships can be included:
\n","_postman_id":"7e5a7803-2ebf-4812-82ea-1adba06a7846"},{"name":"/workflowschedules","item":[{"name":"Retrieve a list of schedules","event":[{"listen":"test","script":{"id":"52f987ec-728a-4b1c-893e-4b8ca9b00a62","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"da7aa570-d225-4504-909e-0b84c91e2af7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/workflowschedules?page[limit]&page[offset]&sort=&filter[attribute]&include=","urlObject":{"path":["v2","workflowschedules"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: workflow.
Include additional related resources
\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"type":"any","value":"{{workflowschedule_id}}","key":"workflowschedule_id"}]}},"response":[{"id":"0998c6c6-9da0-493f-9592-3b8efdc50805","name":"Retrieve a schedule","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/workflowschedules/:workflowschedule_id?include=","host":["{{base_url}}"],"path":["v2","workflowschedules",":workflowschedule_id"],"query":[{"key":"include","value":"","description":"Include additional related resources"}],"variable":[{"key":"workflowschedule_id","value":"{{workflowschedule_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 16 Apr 2024 15:21:46 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X23a57e825babc8eb45f069a6b9cd7205"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-G31UbujpcXSQ5zUe92SDBj9txnqBXdjx';style-src 'self' 'nonce-G31UbujpcXSQ5zUe92SDBj9txnqBXdjx';font-src 'self' data:"},{"key":"Request-Id","value":"f57a3cee-92f6-4156-88c0-3732b6e80b8c"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowschedule\",\n \"id\": \"2\",\n \"attributes\": {\n \"start_time\": \"2025-01-01T18:00:00Z\",\n \"timezone\": \"Europe/Amsterdam\",\n \"adjust_for_dst\": true,\n \"frequency\": \"daily\",\n \"frequency_modifier\": 2,\n \"next_run\": \"2025-01-01T18:00:00Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowschedules/2\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowschedules/2/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowschedules/2/workflow\"\n }\n }\n }\n }\n}"}],"_postman_id":"14ac0228-8d7f-4009-852f-f406435c7549"},{"name":"Update a schedule","event":[{"listen":"test","script":{"id":"0dcc27c1-e03b-47db-801c-e7282603ee80","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('workflowschedule');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"workflowschedule_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.include({"," \"start_time\": \"2020-01-01T18:00:00Z\","," \"timezone\": \"Europe/London\","," \"adjust_for_dst\": true,"," \"frequency\": \"daily\","," \"frequency_modifier\": 2"," });","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"a9e8558b-6eda-410d-89f4-9222eb2b4acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"workflowschedule\",\r\n \"id\": \"{{workflowschedule_id}}\",\r\n \"attributes\": {\r\n \"timezone\": \"Europe/London\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/workflowschedules/:workflowschedule_id","urlObject":{"path":["v2","workflowschedules",":workflowschedule_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{workflowschedule_id}}","key":"workflowschedule_id"}]}},"response":[{"id":"fa08c4c9-779f-419a-8268-d671b68c7db4","name":"Change timezone","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"workflowschedule\",\r\n \"id\": \"{{workflowschedule_id}}\",\r\n \"attributes\": {\r\n \"timezone\": \"Europe/London\"\r\n }\r\n }\r\n}"},"url":{"raw":"{{base_url}}/v2/workflowschedules/:workflowschedule_id","host":["{{base_url}}"],"path":["v2","workflowschedules",":workflowschedule_id"],"variable":[{"key":"workflowschedule_id","value":"{{workflowschedule_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 16 Apr 2024 15:22:04 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xa6e9f4dc3a265186c32984e7028235df"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-2Is0IpYkLkSwrtVpg21cxSnmaWWoByNz';style-src 'self' 'nonce-2Is0IpYkLkSwrtVpg21cxSnmaWWoByNz';font-src 'self' data:"},{"key":"Request-Id","value":"4d68f058-52b8-48e8-a7ff-889b3d43b1c7"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowschedule\",\n \"id\": \"2\",\n \"attributes\": {\n \"start_time\": \"2025-01-01T18:00:00Z\",\n \"timezone\": \"Europe/London\",\n \"adjust_for_dst\": true,\n \"frequency\": \"daily\",\n \"frequency_modifier\": 2,\n \"next_run\": \"2025-01-01T18:00:00Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowschedules/2\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowschedules/2/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowschedules/2/workflow\"\n }\n }\n }\n }\n}"}],"_postman_id":"a9e8558b-6eda-410d-89f4-9222eb2b4acc"},{"name":"Delete a schedule","event":[{"listen":"test","script":{"id":"c4a6e737-3b93-4a83-8224-787d2a01deb3","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET workflowschedule_id');","pm.environment.unset(\"workflowschedule_id\");",""],"type":"text/javascript"}}],"id":"1247f6fd-e583-49c5-9d49-a2fd44a36fb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/workflowschedules/:workflowschedule_id","urlObject":{"path":["v2","workflowschedules",":workflowschedule_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{workflowschedule_id}}","key":"workflowschedule_id"}]}},"response":[{"id":"2d7bed3c-d431-42c9-898d-41ba4ac57f6e","name":"Delete a schedule","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/v2/workflowschedules/:workflowschedule_id","host":["{{base_url}}"],"path":["v2","workflowschedules",":workflowschedule_id"],"variable":[{"key":"workflowschedule_id","value":"{{workflowschedule_id}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 16 Apr 2024 15:23:50 GMT"},{"key":"X-Clockwork-Id","value":"X40ce1145a0e2631b39e575a9f7a1c778"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X40ce1145a0e2631b39e575a9f7a1c778"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-Nxis3X8vDMbWgPIF0g6VbmPQ0Ba5JLmB';style-src 'self' 'nonce-Nxis3X8vDMbWgPIF0g6VbmPQ0Ba5JLmB';font-src 'self' data:"},{"key":"Request-Id","value":"bec4ed7c-ed5b-432f-92b8-cfc0efb9dbbb"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1247f6fd-e583-49c5-9d49-a2fd44a36fb9"}],"id":"5ef8f131-98e0-43d4-85e5-68b3fa499746","description":"Atomic support: βοΈ
\nExivity documentation:
https://docs.exivity.com/architecture%20concepts/glossary/#workflowschedule
Schedule how often a workflow should run.
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"ca12ff63-7ca9-4df1-8b76-a47b52a28348","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29b81b8f-5dd1-4711-96bd-d149bebc304a","type":"text/javascript","exec":[""]}}],"_postman_id":"5ef8f131-98e0-43d4-85e5-68b3fa499746"},{"name":"/workflowsteps","item":[{"name":"Add a new extract step","event":[{"listen":"test","script":{"id":"6440a4bf-4da0-40fc-85d2-116ad31db9f1","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('workflowstep');"," pm.expect(response.data.id).to.not.be.undefined;"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.include({","\t\t\"type\": \"transform\",","\t\t\"sort\": 1,","\t\t\"timeout\": 600,","\t});","\tpm.expect(response.data.attributes.options).to.be.an('object');","\tpm.expect(response.data.attributes.options).to.include({","\t\t\"script\": \"Workflow_transformer\","," \"from_date_offset\": -2,","\t\t\"to_date_offset\": 2","\t});","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"transcript_workflowstep_id\", response.data.id);","console.log('SET transcript_workflowstep_id: ' + pm.environment.get(\"transcript_workflowstep_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"086a95f3-67c4-4dcc-814c-f8045918483a","exec":["pm.sendRequest({\r"," url: pm.variables.get(\"base_url\") + '/v1/transformers',\r"," method: 'POST',\r"," header: {\r"," 'Accept': 'application/json',\r"," 'Content-Type': 'application/json',\r"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")\r"," },\r"," body: {\r"," mode: 'raw',\r"," raw: JSON.stringify({\r","\t \"name\": \"Workflow transformer\",\r","\t \"contents\": \"# script here\"\r"," })\r"," }\r","})"],"type":"text/javascript"}}],"id":"ea6f01ba-fe9e-4e87-8993-57c6759b8e69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"workflowstep\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"step_type\": \"extract\",\r\n\t\t\t\"timeout\": 600,\r\n\t\t\t\"options\": {\r\n\t\t\t\t\"script\": \"Workflow_extractor\",\r\n\t\t\t\t\"from_date_offset\": -2,\r\n\t\t\t\t\"to_date_offset\": -1,\r\n\t\t\t\t\"arguments\": \"arg3 arg4\"\r\n\t\t\t}\r\n\t\t},\r\n\t\t\"relationships\": {\r\n\t\t\t\"workflow\": {\r\n\t\t\t\t\"data\": {\r\n\t\t\t\t\t\"type\": \"workflow\",\r\n\t\t\t\t\t\"id\": \"{{workflow_id}}\"\r\n\t\t\t\t}\r\n\t\t\t}\r\n \t}\r\n\t}\r\n}"},"url":"{{base_url}}/v2/workflowsteps","description":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: workflow, steplogs.
Include additional related resources. Possible values: steplogs, workflow.
Workflow step ID
\n","type":"text/plain"},"type":"string","value":"{{proximity_workflowstep_id}}","key":"workflowstep_id"}]}},"response":[{"id":"f589bff5-5d4c-463c-8a0d-246472e5fab1","name":"Retrieve a step","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/workflowsteps/:workflowstep_id?include=","host":["{{base_url}}"],"path":["v2","workflowsteps",":workflowstep_id"],"query":[{"key":"include","value":"","description":"Include additional related resources. Possible values: `steplogs`, `workflow`."}],"variable":[{"id":"d0d59496-a9f2-44a2-a5f7-1e44bb22790a","key":"workflowstep_id","value":"{{proximity_workflowstep_id}}","type":"string","description":"Workflow step ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 14 Apr 2022 11:45:14 GMT"},{"key":"Date","value":"Thu, 14 Apr 2022 11:45:14 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xbe27447d0a4a32ac69921761806252ec"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-79EFJNtvjbVrpa1Q6e60GreAhyH8ykuF';style-src 'self' 'nonce-79EFJNtvjbVrpa1Q6e60GreAhyH8ykuF';font-src 'self' data:"},{"key":"Request-Id","value":"f5a1545f-ba74-4401-8ca8-15ba66a1aa8a"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowstep\",\n \"id\": \"13\",\n \"attributes\": {\n \"prev\": null,\n \"next\": null,\n \"type\": \"proximity\",\n \"options\": {\n \"command\": \"exivity:gc\",\n \"arguments\": \"\"\n },\n \"timeout\": 600,\n \"wait\": true\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/13\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/13/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/13/workflow\"\n }\n },\n \"steplogs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/13/relationships/steplogs\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/13/steplogs\"\n }\n }\n }\n }\n}"}],"_postman_id":"83bbd63b-ed9b-4965-9bd4-5d41393c6bd1"},{"name":"Update a step","event":[{"listen":"test","script":{"id":"68d4016e-9555-46ce-bea1-0cfc722977f8","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('workflowstep');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"execute_workflowstep_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.include({"," \"type\": \"execute\","," \"sort\": 1,"," \"timeout\": 600"," });"," pm.expect(response.data.attributes.options).to.be.an('object');"," pm.expect(response.data.attributes.options).to.include({\"command\": \"echo \\\"testing\\\"\"});","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"b6d56653-4dc8-429a-894a-689f82f69fff","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireWorkflow)\r"," .then(api.requireWorkflowExecuteStep)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"7225abd8-7f6f-4cc3-bc96-046878e089a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"id\": \"{{execute_workflowstep_id}}\",\r\n \"attributes\": {\r\n \"options\": {\r\n \"command\": \"echo \\\"testing\\\"\",\r\n \"arguments\": \"test\"\r\n }\r\n }\r\n }\r\n}\r\n"},"url":"{{base_url}}/v2/workflowsteps/:workflowstep_id","urlObject":{"path":["v2","workflowsteps",":workflowstep_id"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"dc729ade-d4b7-47cb-81b0-866faf533f4b","type":"string","value":"{{execute_workflowstep_id}}","key":"workflowstep_id"}]}},"response":[{"id":"521982e1-9a95-4c98-8028-7c84fcdf116c","name":"Update an execute step","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"workflowstep\",\r\n \"id\": \"{{execute_workflowstep_id}}\",\r\n \"attributes\": {\r\n \"options\": {\r\n \"command\": \"echo \\\"testing\\\"\",\r\n \"arguments\": \"test\"\r\n }\r\n }\r\n }\r\n}\r\n"},"url":{"raw":"{{base_url}}/v2/workflowsteps/:workflowstep_id","host":["{{base_url}}"],"path":["v2","workflowsteps",":workflowstep_id"],"variable":[{"id":"dc729ade-d4b7-47cb-81b0-866faf533f4b","key":"workflowstep_id","value":"{{execute_workflowstep_id}}","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 05 Sep 2023 12:18:12 GMT"},{"key":"Date","value":"Tue, 05 Sep 2023 12:18:12 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xdd04dd4dcc6b37f8be0f445befb6da76"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-8O2PX5zNQFeRJARYIz0QxcoykY2teAxg';style-src 'self' 'nonce-8O2PX5zNQFeRJARYIz0QxcoykY2teAxg';font-src 'self' data:"},{"key":"Request-Id","value":"e269fd55-3b06-46f7-8939-a1ea6dbae65a"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowstep\",\n \"id\": \"26\",\n \"attributes\": {\n \"step_type\": \"execute\",\n \"options\": {\n \"command\": \"echo \\\"testing\\\"\"\n },\n \"timeout\": 600,\n \"wait\": true\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/26\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/26/relationships/workflow\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/26/workflow\"\n }\n },\n \"steplogs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/26/relationships/steplogs\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/26/steplogs\"\n }\n },\n \"previous\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/workflowsteps/26/relationships/previous\",\n \"related\": \"http://localhost:8012/v2/workflowsteps/26/previous\"\n }\n }\n }\n }\n}"}],"_postman_id":"7225abd8-7f6f-4cc3-bc96-046878e089a2"},{"name":"Fetch step logs","event":[{"listen":"test","script":{"id":"b00d03a7-3063-4470-ac62-2442e1745ba3","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains logs data\", function () {"," pm.expect(response.logs).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"a09376f9-4da4-4efb-aa74-592e766d1cb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/workflowsteps/:workflowstep_id/logs","urlObject":{"path":["v2","workflowsteps",":workflowstep_id","logs"],"host":["{{base_url}}"],"query":[],"variable":[{"id":"647fe166-cb9f-4bd2-840d-11c0ab47b70c","type":"string","value":"{{workflowstep_id}}","key":"workflowstep_id"}]}},"response":[],"_postman_id":"a09376f9-4da4-4efb-aa74-592e766d1cb9"},{"name":"Delete a step","event":[{"listen":"test","script":{"id":"a15c9978-2e12-418e-bf53-f9090f80c1fa","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET workflowstep_id');","pm.environment.unset(\"workflowstep_id\");","","console.log(\"Go back to running a workflow.\");","postman.setNextRequest(\"Run a workflow\");"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"d9199a94-7426-4f91-b71a-05deb6a37143","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireWorkflow)\r"," .then(api.requireWorkflowExecuteStep)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"11a28e57-6116-414b-b3d6-cd17850c8e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/workflowsteps/:workflowstep_id","description":"On success, aΒ HTTP 204 No Content success status responseΒ will be returned.
Atomic support: βοΈ
\nA workflow requires one or more steps. These steps are executed when a workflow is run.
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"d8c2c4a6-f7bc-468e-b8c2-b54757785307","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d611722a-3cb9-49da-b936-d18293b2fec7","type":"text/javascript","exec":[""]}}],"_postman_id":"807d9f0f-e4b9-4c02-b7e8-6111ec045254"},{"name":"/workflowruns","item":[{"name":"Retrieve a list of workflow runs","event":[{"listen":"test","script":{"id":"24fe35a0-1a4c-402e-849c-0c6077174dc3","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data[0]).to.be.an('object');"," pm.expect(response.data[0].type).to.eql('workflowrun');","});","","// Set the workflow run ID to the first response ID","pm.environment.set(\"workflowrun_id\", response.data[0].id);","console.log('SET workflowrun_id: ' + pm.environment.get(\"workflowrun_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"78f3c89e-0268-4874-ab38-bef58ea98f8e","exec":["const api = eval(pm.globals.get('exivity'))();","","api.start()"," .then(api.requireToken)"," .then(api.requireWorkflow)"," .then(api.requireWorkflowExecuteStep)"," .then(api.runWorkflow)"," .then(api.ready)"," .catch(function(err) {"," console.log(err);"," });",""],"type":"text/javascript"}}],"id":"c5ff5a80-0c9b-41fd-b56a-0ff737033137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/workflowruns?page[limit]=&page[offset]=&sort&filter[attribute]&include=","urlObject":{"path":["v2","workflowruns"],"host":["{{base_url}}"],"query":[{"key":"page[limit]","value":""},{"key":"page[offset]","value":""},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"key":"filter[attribute]","value":null},{"key":"include","value":""}],"variable":[]}},"response":[{"id":"93a45046-b6ce-45dc-a08b-ad898abebc65","name":"Retrieve a list of workflow runs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/workflowruns?page[limit]=&page[offset]=&sort&filter[attribute]&include=","host":["{{base_url}}"],"path":["v2","workflowruns"],"query":[{"key":"page[limit]","value":"","description":"Limit the amount of results returned"},{"key":"page[offset]","value":"","description":"Return this page of the results"},{"key":"sort","value":null,"description":"Sort results by this attribute"},{"key":"filter[attribute]","value":null,"description":"Filter results by this attribute"},{"key":"include","value":"","description":"Include additional related resources. Possible values: `workflow`, `steplogs`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 23 May 2022 06:54:17 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-RujeBWiWjsiRvo5q0cHBRlqqsFoDOmyA';style-src 'self' 'nonce-RujeBWiWjsiRvo5q0cHBRlqqsFoDOmyA';font-src 'self' data:"},{"key":"Request-Id","value":"88061782-7b33-43ec-8cd4-e91675ea7efe"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflowrun\",\n \"id\": \"3\",\n \"attributes\": {\n \"start_date\": \"2022-05-23T06:46:12Z\",\n \"end_date\": \"2022-05-23T06:46:13Z\",\n \"status\": \"failed\"\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/3\"\n },\n \"relationships\": {\n \"steplogs\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/3/relationships/steplogs\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/3/steplogs\"\n }\n },\n \"workflow\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/3/relationships/workflow\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/3/workflow\"\n }\n }\n }\n },\n {\n \"type\": \"workflowrun\",\n \"id\": \"10\",\n \"attributes\": {\n \"start_date\": \"2022-05-23T06:54:16Z\",\n \"end_date\": \"2022-05-23T06:54:16Z\",\n \"status\": \"success\"\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/10\"\n },\n \"relationships\": {\n \"steplogs\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/10/relationships/steplogs\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/10/steplogs\"\n }\n },\n \"workflow\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/10/relationships/workflow\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/10/workflow\"\n }\n }\n }\n },\n {\n \"type\": \"workflowrun\",\n \"id\": \"8\",\n \"attributes\": {\n \"start_date\": \"2022-05-23T06:48:28Z\",\n \"end_date\": \"2022-05-23T06:48:28Z\",\n \"status\": \"success\"\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/8\"\n },\n \"relationships\": {\n \"steplogs\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/8/relationships/steplogs\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/8/steplogs\"\n }\n },\n \"workflow\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns/8/relationships/workflow\",\n \"related\": \"https://dev.exivity.net/v2/workflowruns/8/workflow\"\n }\n }\n }\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 3,\n \"count\": 3,\n \"per_page\": 15,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/workflowruns?page%5Blimit%5D=&sort=&filter%5Battribute%5D=&include=&page%5Boffset%5D=1\",\n \"first\": \"https://dev.exivity.net/v2/workflowruns?page%5Blimit%5D=&sort=&filter%5Battribute%5D=&include=&page%5Boffset%5D=1\",\n \"last\": \"https://dev.exivity.net/v2/workflowruns?page%5Blimit%5D=&sort=&filter%5Battribute%5D=&include=&page%5Boffset%5D=1\"\n }\n}"}],"_postman_id":"c5ff5a80-0c9b-41fd-b56a-0ff737033137"},{"name":"Retrieve a workflow run","event":[{"listen":"test","script":{"id":"26fff38d-997f-4130-ac7c-08c4f19fa014","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('workflowrun');"," pm.expect(response.data.attributes.start_date).to.be.a('string');"," pm.expect(response.data.attributes.end_date).to.be.a('string');"," pm.expect(response.data.attributes.status).to.be.a('string');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f5e5823c-b9ab-47ba-bc77-8c8242ea9edf","exec":[""],"type":"text/javascript"}}],"id":"924bdb68-ed29-4025-bb66-7760c05bd92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/workflowruns/:workflowrun_id?include=","urlObject":{"path":["v2","workflowruns",":workflowrun_id"],"host":["{{base_url}}"],"query":[{"description":{"content":"Include additional related resources. Possible values: steplogs, workflow
Atomic support: β
\nRuns contain workflow status information of workflow runs.
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"cb83b8f4-ebee-410f-8762-abd54ca391a6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b0f5f4d3-988a-4948-9274-c6ecfc8246fb","type":"text/javascript","exec":[""]}}],"_postman_id":"ccee36d4-fb7a-45e6-ab6c-d57541cce45b"},{"name":"/workflowsteplogs","item":[{"name":"Retrieve a list of workflow step logs","event":[{"listen":"prerequest","script":{"id":"3e4fdc31-2d25-4f36-8e84-73cdac7871f9","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.requireWorkflow)\r"," .then(api.requireWorkflowExecuteStep)\r"," .then(api.runWorkflow)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}},{"listen":"test","script":{"id":"841c835a-2b22-45c0-8633-078f2347d591","exec":["// Since running a workflow is an async process, so we can't know","// for sure that a workflowsteplog has any info, so just check for a basic valid format","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');"," if (response.data.length > 0 ) {"," // We have some results to validate"," pm.expect(response.data[0]).to.be.an('object');"," pm.expect(response.data[0].type).to.eql('workflowsteplog');"," "," pm.environment.set(\"workflowsteplog_id\", response.data[0].id);"," console.log('SET workflowsteplog_id: ' + pm.environment.get(\"workflowsteplog_id\"));"," }","});","pm.test(\"Response contains meta\", function () {"," pm.expect(response.meta).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"60ef2fe8-fbbb-4f9c-a8a7-79d8bd2a9c0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/workflowsteplogs?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","workflowsteplogs"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: run, step.
Include additional related resources. Possible values: run, step.
Atomic support: β
\nA steplog contains information about a workflowstep that ran.
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"fc1698ca-81c8-40a3-ace8-a389c6395476","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c2aae1f4-3843-4dea-82a3-d5c938d9012a","type":"text/javascript","exec":[""]}}],"_postman_id":"f1888093-edec-42a5-ba39-7f2130faaf58"},{"name":"/jobs","item":[{"name":"Retrieve a list of jobs","event":[{"listen":"test","script":{"id":"08292015-685f-409c-ae28-f64a21c2d650","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"acf6b7de-a79a-44be-afdb-d5bb4ab779ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/jobs?filter[attribute]=","urlObject":{"path":["v2","jobs"],"host":["{{base_url}}"],"query":[{"description":{"content":"Filter results by this attribute.
\n","type":"text/plain"},"key":"filter[attribute]","value":""}],"variable":[]}},"response":[{"id":"273c253b-8711-4dcb-9a35-21376997ae2f","name":"Retrieve a list of jobs","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/jobs?filter[attribute]=","host":["{{base_url}}"],"path":["v2","jobs"],"query":[{"key":"filter[attribute]","value":"","description":"Filter results by this attribute."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 11 Oct 2022 14:22:54 GMT"},{"key":"Date","value":"Tue, 11 Oct 2022 14:22:54 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X646eabcd09f5835f0f709e6c764dffdc"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-1dNnHl0muGvLZQluqti348zCpB9Wj1z6';style-src 'self' 'nonce-1dNnHl0muGvLZQluqti348zCpB9Wj1z6';font-src 'self' data:"},{"key":"Request-Id","value":"7bba2ec6-20c6-4cc0-8d8c-7c8a07295f5a"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"job\",\n \"id\": \"2\",\n \"attributes\": {\n \"user_id\": \"\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:14Z\",\n \"end_date\": \"2022-09-29T07:21:14Z\",\n \"job_type\": \"extract\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/2\"\n }\n },\n {\n \"type\": \"job\",\n \"id\": \"1\",\n \"attributes\": {\n \"user_id\": \"f68c6888-46a9-41bd-ae5a-03b81a53d933\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:14Z\",\n \"end_date\": \"2022-09-29T07:21:14Z\",\n \"job_type\": null\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/1\"\n }\n },\n {\n \"type\": \"job\",\n \"id\": \"4\",\n \"attributes\": {\n \"user_id\": \"\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:15Z\",\n \"end_date\": \"2022-09-29T07:21:15Z\",\n \"job_type\": \"extract\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/4\"\n }\n },\n {\n \"type\": \"job\",\n \"id\": \"3\",\n \"attributes\": {\n \"user_id\": \"f68c6888-46a9-41bd-ae5a-03b81a53d933\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:15Z\",\n \"end_date\": \"2022-09-29T07:21:15Z\",\n \"job_type\": null\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/3\"\n }\n },\n {\n \"type\": \"job\",\n \"id\": \"6\",\n \"attributes\": {\n \"user_id\": \"\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:17Z\",\n \"end_date\": \"2022-09-29T07:21:17Z\",\n \"job_type\": \"extract\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/6\"\n }\n },\n {\n \"type\": \"job\",\n \"id\": \"5\",\n \"attributes\": {\n \"user_id\": \"f68c6888-46a9-41bd-ae5a-03b81a53d933\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:17Z\",\n \"end_date\": \"2022-09-29T07:21:17Z\",\n \"job_type\": null\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/5\"\n }\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 6,\n \"count\": 6,\n \"per_page\": 10,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs?filter%5Battribute%5D=&page%5Boffset%5D=1\",\n \"first\": \"http://localhost:8012/v1/jobs?filter%5Battribute%5D=&page%5Boffset%5D=1\",\n \"last\": \"http://localhost:8012/v1/jobs?filter%5Battribute%5D=&page%5Boffset%5D=1\"\n }\n}"}],"_postman_id":"acf6b7de-a79a-44be-afdb-d5bb4ab779ce"},{"name":"Add a new job","event":[{"listen":"test","script":{"id":"138c7138-89e8-41d7-98c5-af13c74b7615","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('job');"," pm.expect(response.data.id).to.not.be.undefined;"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.include({"," \"job_type\": \"extract\""," });"," pm.expect(response.data.attributes.status).to.be.a('string');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"job_id\", response.data.id);","console.log('SET job_id: ' + pm.environment.get(\"job_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e685c260-0a1e-4e10-93db-4e22b94d2cfd","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"09702c80-6d9c-48d5-b23e-6bfaf015463b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"job\",\r\n \t\"attributes\": {\r\n \"job_type\": \"prepare_report\",\r\n \"options\": {\r\n \"report_id\": \"{{report_id}}\",\r\n \"start_date\": null,\r\n \"end_date\": null\r\n }\r\n \t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/jobs","urlObject":{"path":["v2","jobs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"46d314a8-5839-42cb-8dc7-8640344b985b","name":"Add extract job","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"job\",\r\n \t\"attributes\": {\r\n \"job_type\": \"extract\",\r\n \"options\": {\r\n \"extractor_name\": \"{{extractor_name}}\"\r\n }\r\n \t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.0"},{"key":"Location","value":"http://localhost:8012/v2/Job/Jobs"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 07 May 2024 08:40:56 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X21a8588465dbf7f1722bf77566227b6b"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-1tFaDvqeoJ9wZeNJYaq3lGVRLiQrTtpJ';style-src 'self' 'nonce-1tFaDvqeoJ9wZeNJYaq3lGVRLiQrTtpJ';font-src 'self' data:"},{"key":"Request-Id","value":"10addda3-2d02-4ee8-a1b1-37647d1c3927"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"job\",\n \"id\": \"9\",\n \"attributes\": {\n \"job_type\": \"extract\",\n \"status\": \"running\",\n \"start_datetime\": \"2024-05-07T08:40:56Z\",\n \"end_datetime\": null,\n \"timeout\": 0,\n \"options\": {\n \"extractor_name\": \"Extractor_test_-_27.use\",\n \"arguments\": null,\n \"environment_id\": null\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/9\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/9/relationships/user\",\n \"related\": \"http://localhost:8012/v2/jobs/9/user\"\n }\n }\n }\n }\n}"},{"id":"a8e21ba8-3103-4aa6-9a86-466b31c4c3b3","name":"Add prepare report job","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"job\",\r\n \t\"attributes\": {\r\n \t\t\"job_type\": \"prepare_report\",\r\n \"options\": {\r\n \"report_id\": \"{{report_id}}\",\r\n \"start_date\": null,\r\n \"end_date\": null\r\n }\r\n \t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 23 May 2022 14:49:23 GMT"},{"key":"Date","value":"Mon, 23 May 2022 14:49:23 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/v2/Job/Jobs"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X37afc407b9006dd3076e20d01bbafe2e"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-5o3aFnYGqccuzNDd38aqGfAoEwZtcB0m';style-src 'self' 'nonce-5o3aFnYGqccuzNDd38aqGfAoEwZtcB0m';font-src 'self' data:"},{"key":"Request-Id","value":"d091d0d9-fb97-460a-a3ab-3c7c21626710"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"job\",\n \"id\": \"9\",\n \"attributes\": {\n \"status\": \"running\",\n \"start_datetime\": \"2023-11-06T10:16:42Z\",\n \"end_datetime\": null,\n \"job_type\": \"prepare_report\",\n \"timeout\": 0,\n \"options\": {\n \"report_id\": \"1\",\n \"start_date\": \"2023-11-06\",\n \"end_date\": \"2023-11-06\"\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/9\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/9/relationships/user\",\n \"related\": \"http://localhost:8012/v2/jobs/9/user\"\n }\n }\n }\n }\n}"},{"id":"bd68e523-43a0-47e4-9666-81718878597d","name":"Add transform job","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"job\",\r\n \t\"attributes\": {\r\n \t\t\"job_type\": \"transform\",\r\n \"options\": {\r\n \"transformer_name\": \"{{transformer_name}}\",\r\n \"start_date\": null,\r\n \"end_date\": null,\r\n \"date\": null\r\n }\r\n \t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v2/jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 06 Nov 2023 11:29:04 GMT"},{"key":"Date","value":"Mon, 06 Nov 2023 11:29:04 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/v2/Job/Jobs"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X7cb1f634501c919d959e8ce4ba11df02"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-nae6j6e8lTjfewaGZpGOxiiJwURnPfui';style-src 'self' 'nonce-nae6j6e8lTjfewaGZpGOxiiJwURnPfui';font-src 'self' data:"},{"key":"Request-Id","value":"ec1fd179-3104-4d02-ab39-0fcbeebb9754"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"job\",\n \"id\": \"16\",\n \"attributes\": {\n \"job_type\": \"transform\",\n \"status\": \"running\",\n \"start_datetime\": \"2023-11-06T11:29:04Z\",\n \"end_datetime\": null,\n \"timeout\": 0,\n \"options\": {\n \"transformer_name\": \"Transformer_test_69.trs\",\n \"environment_id\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"date\": \"2023-11-06\"\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/16\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v2/jobs/16/relationships/user\",\n \"related\": \"http://localhost:8012/v2/jobs/16/user\"\n }\n }\n }\n }\n}"}],"_postman_id":"09702c80-6d9c-48d5-b23e-6bfaf015463b"},{"name":"Retrieve a job","event":[{"listen":"test","script":{"id":"08292015-685f-409c-ae28-f64a21c2d650","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"53d2347a-4bb0-47bf-9cba-504ad209c790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/jobs/:job_id?include=log","urlObject":{"path":["v2","jobs",":job_id"],"host":["{{base_url}}"],"query":[{"key":"include","value":"log"}],"variable":[{"type":"any","value":"{{job_id}}","key":"job_id"}]}},"response":[{"id":"951002fc-ac7e-488a-8c69-1556d185c57e","name":"Retrieve a job","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v2/jobs/:job_id","host":["{{base_url}}"],"path":["v2","jobs",":job_id"],"variable":[{"id":"00310810-0289-443a-b09a-dc1c4a9e928e","key":"job_id","value":"{{job_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 11 Oct 2022 14:31:13 GMT"},{"key":"Date","value":"Tue, 11 Oct 2022 14:31:13 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X0081f1085bfc96f95a8070da04acafa7"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-y0I1ThEGCzz3WdrGB7MRnuBy3ueo4AwA';style-src 'self' 'nonce-y0I1ThEGCzz3WdrGB7MRnuBy3ueo4AwA';font-src 'self' data:"},{"key":"Request-Id","value":"36f22853-1972-4cf2-930c-6711475ba759"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"job\",\n \"id\": \"2\",\n \"attributes\": {\n \"user_id\": \"\",\n \"status\": \"failed\",\n \"start_date\": \"2022-09-29T07:21:14Z\",\n \"end_date\": \"2022-09-29T07:21:14Z\",\n \"job_type\": \"extract\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/jobs/2\"\n }\n }\n}"}],"_postman_id":"53d2347a-4bb0-47bf-9cba-504ad209c790"}],"id":"c670d0f2-38f0-49c7-9613-f59aead44ff9","description":"Atomic support: βοΈ
\nJobs are long-running processes, running in the background.
\nThis job will be handled by the Use backend component.
\nThis job will be handled by the Edify backend component.
\nThis job will be handled by the Transcript backend component.
\n","_postman_id":"c670d0f2-38f0-49c7-9613-f59aead44ff9"}],"id":"0f7982be-f248-4da5-bafd-f898ba3f02e7","event":[{"listen":"prerequest","script":{"id":"5c405237-9db3-4d39-94e9-4655192ce527","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1ee0ce50-9cb9-481a-9013-c60923713415","type":"text/javascript","exec":[""]}}],"_postman_id":"0f7982be-f248-4da5-bafd-f898ba3f02e7","description":""},{"name":"Profile","item":[{"name":"/notificationchannels","item":[{"name":"Get all notification channels","event":[{"listen":"test","script":{"id":"35dece05-a534-4451-b1d4-11768ff68334","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"f4433dee-e858-48bc-b929-6bf16fc115dc","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"74720957-6e5f-4199-bbb6-d71b3e3a2f6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/notificationchannels?include=","urlObject":{"path":["v2","notificationchannels"],"host":["{{base_url}}"],"query":[{"description":{"content":"Possible values: notificationsubscriptions, user.
Atomic support: βοΈ
\nNotifications are messages that are sent to a specific channel (e-mail, SMS, Slack, webhook) based on an event such as a Published Report, a Budget Evaluation, or a Workflow exit status.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#notificationchannel
\nInfo Object
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"a6a578fd-23c4-4913-b8ac-0219a497fbc0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7576bfc7-5167-4b67-9ea1-5339c1485d54","type":"text/javascript","exec":[""]}}],"_postman_id":"e84e190a-43f2-4a3d-b159-da0a27a9eb1d"},{"name":"/notificationsubscriptions","item":[{"name":"Get all notifications subscriptions","event":[{"listen":"test","script":{"id":"f64408c6-18b1-45bf-b9f3-0fe8664594a7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});","","if (response.data.length) {"," pm.environment.set(\"notification_subscritpion_id\", response.data[0].id);"," console.log('SET notification_subscritpion_id: ' + pm.environment.get(\"notification_subscritpion_id\"));","}",""],"type":"text/javascript"}}],"id":"0b3b4d9f-56f5-4a54-b06c-c8d4530179fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"url":"{{base_url}}/v2/notificationsubscriptions?page[limit]=1&page[offset]=&sort=&filter[name]=&include=","urlObject":{"path":["v2","notificationsubscriptions"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":"1"},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":""},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: user, channels, notificationchannels
Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":""},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":""},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: user, channels, notificationchannels
Atomic support: βοΈ
\nNotifications are messages that are sent to a specific channel (e-mail, SMS, Slack, webhook) based on an event such as a Published Report, a Budget Evaluation, or a Workflow exit status.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#notification
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"ba4ceb8e-64fa-4e39-887d-d8fd1c2c9c4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a286b1e5-b674-4c05-8fba-6a0ff2c66de4","type":"text/javascript","exec":[""]}}],"_postman_id":"d69feadc-9273-4bb5-b671-48c5a4be20a3"},{"name":"/notifications","item":[{"name":"Get all database notification","event":[{"listen":"test","script":{"id":"612e939d-5eda-415d-b32b-e864d4a242b4","exec":["// pm.test(\"Status code is 200\", function () {","// pm.response.to.have.status(200);","// });","","// const response = pm.response.json();","// console.log(response);","","// pm.test(\"Response contains data\", function () {","// pm.expect(response.data).to.be.an('array');","// });","","// // Set the notification_id to the ID of the first notification","// pm.environment.set(\"notification_id\", response.data[0].id);"],"type":"text/javascript"}}],"id":"f007389b-567b-469a-9224-edd46e809049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/notifications","description":"Get all database notification for auth user
\n","urlObject":{"path":["v2","notifications"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ebe8549b-f516-4fcd-bbfa-98724fd4aed0","name":"Get all database notification","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 16 May 2022 15:24:51 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-OvwsVLLv75RSKUgf8x2dcm7QsNUzvHjD';style-src 'self' 'nonce-OvwsVLLv75RSKUgf8x2dcm7QsNUzvHjD';font-src 'self' data:"},{"key":"Request-Id","value":"d516bbad-94fd-4ec9-9e9d-5fd8e84fa3f4"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"notification\",\n \"id\": \"9222c0ad-b1a1-4d02-8d45-c90e2e2ddcb5\",\n \"attributes\": {\n \"type\": \"App\\\\Model\\\\Notifications\\\\Workflow\\\\WorkflowEndedSuccessNotification\",\n \"notifiable_type\": \"App\\\\User\",\n \"notifiable_id\": \"f3042cbd-4160-43a8-93e9-0762e4c283f4\",\n \"data\": \"{\\\"Title\\\":\\\"Workflow #10: \\\\\\\"workflow_db_notiftest\\\\\\\" has ended.\\\",\\\"Description\\\":\\\"\\\",\\\"Status\\\":\\\"ended\\\",\\\"Started at\\\":\\\"2022-05-16 15:24:05\\\",\\\"Ended at\\\":\\\"2022-05-16 15:24:05\\\",\\\"ID\\\":10}\",\n \"read_at\": null,\n \"created_at\": 1652714646,\n \"updated_at\": 1652714646\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/notifications/9222c0ad-b1a1-4d02-8d45-c90e2e2ddcb5\"\n }\n },\n {\n \"type\": \"notification\",\n \"id\": \"ff556e5d-3dcc-4730-805a-a72063b1c9ea\",\n \"attributes\": {\n \"type\": \"App\\\\Model\\\\Notifications\\\\Workflow\\\\WorkflowEndedSuccessNotification\",\n \"notifiable_type\": \"App\\\\User\",\n \"notifiable_id\": \"f3042cbd-4160-43a8-93e9-0762e4c283f4\",\n \"data\": \"{\\\"Title\\\":\\\"Workflow #10: \\\\\\\"workflow_db_notiftest\\\\\\\" has ended.\\\",\\\"Description\\\":\\\"\\\",\\\"Status\\\":\\\"ended\\\",\\\"Started at\\\":\\\"2022-05-16 15:24:05\\\",\\\"Ended at\\\":\\\"2022-05-16 15:24:05\\\",\\\"ID\\\":10}\",\n \"read_at\": null,\n \"created_at\": 1652714646,\n \"updated_at\": 1652714646\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/notifications/ff556e5d-3dcc-4730-805a-a72063b1c9ea\"\n }\n }\n ],\n \"meta\": {\n \"pagination\": {\n \"total\": 2,\n \"count\": 2,\n \"per_page\": 10,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/notifications?page%5Boffset%5D=1\",\n \"first\": \"https://dev.exivity.net/v2/notifications?page%5Boffset%5D=1\",\n \"last\": \"https://dev.exivity.net/v2/notifications?page%5Boffset%5D=1\"\n }\n}"}],"_postman_id":"f007389b-567b-469a-9224-edd46e809049"}],"id":"42fa0e8a-00ce-4924-97a0-9ca4ad601c9a","description":"Get all database notifications.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#notification
\n","event":[{"listen":"prerequest","script":{"id":"55fb0702-0aa1-4a18-a15e-10aab71840d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ac687a76-0050-422c-aa53-ab247a7324e8","type":"text/javascript","exec":[""]}}],"_postman_id":"42fa0e8a-00ce-4924-97a0-9ca4ad601c9a"}],"id":"7ea42981-cb45-40d3-ab1b-d53463800f08","_postman_id":"7ea42981-cb45-40d3-ab1b-d53463800f08","description":""},{"name":"Administration","item":[{"name":"/users","item":[{"name":"/users/me","item":[{"name":"Retrieve the current user","event":[{"listen":"test","script":{"id":"e1661d43-ee9f-4fe5-bffa-e6cfda3f38fe","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('user');"," pm.expect(response.data.id).to.not.be.undefined;"," pm.expect(response.data.attributes).to.be.an('object');"," pm.test(\"Response contains keys\", function () {"," pm.expect(response.data.attributes).to.have.property(\"username\");"," pm.expect(response.data.attributes).to.have.property(\"email_address\");"," pm.expect(response.data.attributes).to.have.property(\"account_access_type\");"," pm.expect(response.data.attributes).to.have.property(\"source\");"," pm.expect(response.data.attributes).to.have.property(\"display_name\");"," });","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"user_id\", response.data.id);"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6e328677-e2e5-472e-9530-c19e080efae8","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}}],"id":"8e0d1e20-c291-4bdf-ac87-d7389e3e7ce9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/users/me?include=","urlObject":{"path":["v2","users","me"],"host":["{{base_url}}"],"query":[{"description":{"content":"Include additional related resources. Possible values: accounts, usergroup, channels, notificationsubscriptions.
This will invalidate all previously issued tokens.
\n","urlObject":{"path":["v2","users","me","key"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"70d32d5e-d131-4663-9e8b-790ea548dd99","name":"Generate a new key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true},{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/users/me/key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 16 May 2022 14:45:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-aER6WeSomjeKNTGl3rune7Kxi39imFlM';style-src 'self' 'nonce-aER6WeSomjeKNTGl3rune7Kxi39imFlM';font-src 'self' data:"},{"key":"Request-Id","value":"61cd30f4-d1da-40bd-9114-1e95c44e6cf5"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"rotated\"\n}"}],"_postman_id":"a9dfe07a-69c5-443e-8c39-120e574ea9fd"},{"name":"Update the current users app state","event":[{"listen":"test","script":{"id":"dc953c4b-035d-4385-8aea-f8ddde6e76c5","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct state\", function () {"," pm.expect(response.state).to.be.an('object');"," pm.expect(response.state.key).to.not.be.undefined;","\tpm.expect(response.state.key).to.eql('value');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"37ebcaf3-8471-496f-907c-888c31ec478d","exec":["pm.environment.unset(\"token\");","","const api = eval(pm.globals.get('exivity'))();","","api.start()"," .then(api.requireToken)"," .then(api.ready)"," .catch(function(err) {"," console.log(err);"," });",""],"type":"text/javascript"}}],"id":"3a2b51d4-e234-4472-9fb3-79fdb4e99015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"state\": {\r\n\t\t\"key\": \"value\"\r\n\t}\r\n}"},"url":"{{base_url}}/v2/users/me/state?app=glass","urlObject":{"path":["v2","users","me","state"],"host":["{{base_url}}"],"query":[{"description":{"content":"The client to update the state for. One of glass, lens.
Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: usergroup, accounts.
β οΈ Available since v3.0.0.
\nThis will invalidate all previously issued tokens.
\n","urlObject":{"path":["v2","users","{{new_user_id}}","key"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6700dca-3520-4f8d-b31d-f0dea325ce91","name":"Generate a new key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/users/{{new_user_id}}/key"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 16 May 2022 14:56:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-xUPKYgNEd6WdUyDYB6FsgxkKgWCSA3LB';style-src 'self' 'nonce-xUPKYgNEd6WdUyDYB6FsgxkKgWCSA3LB';font-src 'self' data:"},{"key":"Request-Id","value":"6367e0ae-0f57-41c7-9bc8-d2e9af2144c6"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"rotated\"\n}"}],"_postman_id":"c9661dcf-3a2e-41e8-871f-929be003e3e1"},{"name":"Update a user","event":[{"listen":"test","script":{"id":"26c253d1-7ab3-42de-a921-c1082a1f5849","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains correct data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data.type).to.eql('user');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"new_user_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.test(\"Response contains keys\", function () {"," pm.expect(response.data.attributes).to.have.property(\"username\");"," pm.expect(response.data.attributes).to.have.property(\"email_address\");"," pm.expect(response.data.attributes).to.have.property(\"account_access_type\");"," pm.expect(response.data.attributes).to.have.property(\"source\");"," pm.expect(response.data.attributes).to.have.property(\"display_name\");"," });"," pm.expect(response.data.attributes.username).to.include('modified_user');"," pm.expect(response.data.attributes.email_address).to.include('someone+modified');"," pm.expect(response.data.attributes.email_address).to.include('@exivity.com');"," pm.expect(response.data.attributes.account_access_type).to.eql('all');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"1650c5b0-12d4-4880-8f28-a464d1290d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"user\",\r\n \"id\": \"{{new_user_id}}\",\r\n \"attributes\": {\r\n \"username\": \"modified_user - 172\",\r\n \"email_address\": \"someone+modified_547@exivity.com\",\r\n \"account_access_type\": \"all\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/users/{{new_user_id}}","urlObject":{"path":["v2","users","{{new_user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"23a9bb73-ed2f-4525-a38a-bb2986b14400","name":"Update a user","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"type\": \"user\",\r\n \"id\": \"{{new_user_id}}\",\r\n \"attributes\": {\r\n \"username\": \"modified_user - 327\",\r\n \"email_address\": \"someone+modified_867@exivity.com\",\r\n \"account_access_type\": \"all\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v2/users/{{new_user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 16 May 2022 14:56:24 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-wahl0vwl3rKvaxoI1JcLCQ82bmiX9Cah';style-src 'self' 'nonce-wahl0vwl3rKvaxoI1JcLCQ82bmiX9Cah';font-src 'self' data:"},{"key":"Request-Id","value":"dd07bc5e-a701-4d22-9315-1f450f27f489"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"user\",\n \"id\": \"4e25d605-4ad3-422c-aba4-8d9b97de2b2f\",\n \"attributes\": {\n \"username\": \"modified_user - 851\",\n \"email_address\": \"someone+modified_629@exivity.com\",\n \"account_access_type\": \"all\",\n \"source\": \"local\",\n \"display_name\": \"modified_user - 851\"\n },\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f\"\n },\n \"relationships\": {\n \"usergroup\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/relationships/usergroup\",\n \"related\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/usergroup\"\n }\n },\n \"accounts\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/relationships/accounts\",\n \"related\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/accounts\"\n }\n },\n \"channels\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/relationships/channels\",\n \"related\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/channels\"\n }\n },\n \"notificationchannels\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/relationships/notificationchannels\",\n \"related\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/notificationchannels\"\n }\n },\n \"notificationsubscriptions\": {\n \"links\": {\n \"self\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/relationships/notificationsubscriptions\",\n \"related\": \"https://dev.exivity.net/v2/users/4e25d605-4ad3-422c-aba4-8d9b97de2b2f/notificationsubscriptions\"\n }\n }\n }\n }\n}"}],"_postman_id":"1650c5b0-12d4-4880-8f28-a464d1290d92"},{"name":"Delete a user","event":[{"listen":"test","script":{"id":"58c75dbb-e65e-4f9f-8f87-a8839dd5843a","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET new_user_id');","pm.environment.unset(\"new_user_id\");"],"type":"text/javascript"}}],"id":"5cf9780d-ddad-4e64-8265-e6c82c21753a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/users/{{new_user_id}}","urlObject":{"path":["v2","users","{{new_user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a0d507f8-c111-4a4d-9285-2e3e3d5551c9","name":"Delete a user","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v2/users/{{new_user_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 16 May 2022 14:56:32 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-HhYdRWUAkQlJfhWC4DYrReoUPeWdBEbe';style-src 'self' 'nonce-HhYdRWUAkQlJfhWC4DYrReoUPeWdBEbe';font-src 'self' data:"},{"key":"Request-Id","value":"96fee792-a128-4ac4-86ad-a51fb77b62cf"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5cf9780d-ddad-4e64-8265-e6c82c21753a"}],"id":"1f3ed8fb-4887-4ed4-8bcd-310f2fa13afa","description":"Atomic support: βοΈ
\nEveryone connecting to our API needs a valid user account. Users can change some of their details themselves.
\nUsers with the \"manage_users\" permission can view, create, edit and delete users on the system.
\nExivity documentation: https://docs.exivity.com/administration/user-management/users
\nRelationships
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5a1c713a-47a9-49dc-b7f9-9e2a37c62e6b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea47458b-4ddf-431f-b427-ada009f419f9","type":"text/javascript","exec":[""]}}],"_postman_id":"1f3ed8fb-4887-4ed4-8bcd-310f2fa13afa"},{"name":"/usergroups","item":[{"name":"Retrieve a list of usergroups","event":[{"listen":"test","script":{"id":"e47c38d0-9cfd-4d5f-92d6-22e5029625f4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"1baea7e0-1bf2-40be-a0d3-f160fa17edd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/usergroups?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","usergroups"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: users.
Include additional related resources. Possible values: users.
It is possible to create custom usergroups, with different permissions. Users can be assigned to different usergroups.
\nExivity documentation: https://docs.exivity.com/administration/user-management/groups
\nPermissions
\nPlease see the Exivity documentation for more information on specific permissions: https://docs.exivity.com/administration/user-management/groups#user-permissions
\nThe following is a list of currently supported permission on our system:
\nview_auditview_billingview_budgetsview_cogsview_logsmanage_accountsmanage_cataloguemanage_data_sourcesmanage_datasetsmanage_filesmanage_metadata_definitionsmanage_reportsmanage_settingsmanage_usersmanage_workflowsThe system can be configured using these endpoints.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f1ac1f39-eefb-4d2c-9170-d9209331153e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d6b233c-11e8-4ce0-9543-9a3500990677","type":"text/javascript","exec":[""]}}],"_postman_id":"54727cb4-edf4-44bc-a690-42398893eb0c"},{"name":"/auditentries","item":[{"name":"Get audit trail","event":[{"listen":"test","script":{"id":"9e488dac-f65c-4521-93ed-143afa5b9b03","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","","pm.test(\"Response contains audit data\", function () {"," pm.expect(response.data).to.be.an('array');"," pm.expect(response.data[0]).to.have.property('type');"," pm.expect(response.data[0]).to.have.property('id');"," pm.expect(response.data[0]).to.have.property('attributes');","});"],"type":"text/javascript","packages":{}}}],"id":"e3f4afe1-f429-49e7-9f34-59aba039829b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/auditentries?start=&end=&include=&page[limit]&page[offset]&sort&filter[attribute]","urlObject":{"path":["v2","auditentries"],"host":["{{base_url}}"],"query":[{"description":{"content":"The start of the date range (inclusive) you want to view the audit trail for in YYYY-MM-DD format. Defaults to the current date.
The end of the date range (inclusive) you want to view the audit trail for in YYYY-MM-DD format. Defaults to the current date.
Include additional related resources. Possible values: user
Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Optionally filter results by this attribute.
\n","type":"text/plain"},"key":"filter[attribute]","value":null}],"variable":[]}},"response":[{"id":"6395486c-db17-4783-918b-56af97bf446e","name":"Get audit trail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v2/auditentries?start=&end=&include","host":["{{base_url}}"],"path":["v2","auditentries"],"query":[{"key":"start","value":"","description":"The start of the date range (inclusive) you want to view the audit trail for in `YYYY-MM-DD` format. Defaults to the current date."},{"key":"end","value":"","description":"The end of the date range (inclusive) you want to view the audit trail for in `YYYY-MM-DD` format. Defaults to the current date."},{"key":"include","value":null,"description":"Include additional related resources. Possible values: `user`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 17 May 2022 14:12:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy-Report-Only","value":"report-uri https://sentry.io/api/120999/security/?sentry_key=7935c59cd7ad4e169ed97fac6d9c5f9d;base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-9lK1ZmgLDQDJqWoYCUYhT5OEGiHhFBSU';style-src 'self' 'nonce-9lK1ZmgLDQDJqWoYCUYhT5OEGiHhFBSU';font-src 'self' data:"},{"key":"Request-Id","value":"367f6966-08eb-4c1a-8be8-6617f0fd1530"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"audit\",\n \"id\": \"1\",\n \"attributes\": {\n \"user_id\": \"Atomic support: β
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"d6c0f6d5-6488-437e-88f2-6b077c2e9dcf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a5589975-2c91-42bb-9e96-677c3ddad1da","type":"text/javascript","exec":[""]}}],"_postman_id":"6d705692-f9b7-41cd-bf40-1d39253ebfef","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"/logs","item":[{"name":"Retrieve logfiles","event":[{"listen":"test","script":{"id":"29bf8f21-5497-428c-a397-645446581335","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","","pm.test(\"Response contains logs\", function () {"," pm.expect(response.data).to.be.an('array');"," pm.expect(response.data[0].type).to.eql(\"logfile\");"," pm.expect(response.data[0].id).to.be.a(\"string\");"," pm.expect(response.data[0].attributes).to.be.an(\"object\");","});","","// Next request","","const components = [\"proximity\", \"pigeon\", \"use\", \"transcript\", \"edify\", \"chronos\", \"horizon\", \"merlin\", \"griffon\"];","const previousComponent = pm.environment.get(\"component\");","const nextComponent = components[components.indexOf(previousComponent) + 1];","","pm.environment.set(\"component\", nextComponent);","","if (nextComponent) {"," postman.setNextRequest(\"Retrieve logfiles\");","} else {"," postman.setNextRequest(\"Get a full data dump\");","}"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"cceeced6-0338-4436-bf07-c7390e900c1f","exec":["const component = pm.environment.get(\"component\");","","if (!component) {"," pm.environment.set(\"component\", \"proximity\");","}"],"type":"text/javascript"}}],"id":"1519c7da-15d3-4c2e-a658-0cadd6eccf4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/logs?component=&limit=&filter=&truncate=","urlObject":{"path":["v2","logs"],"host":["{{base_url}}"],"query":[{"description":{"content":"Required, in: extract, transform, prepare_report, proximity, chronos, pigeon, horizon, merlin, griffon
\n","type":"text/plain"},"key":"component","value":""},{"description":{"content":"Limit the maximum number of logfiles to return. Defaults to 100.
Optionally filter the logfiles by filename. Use the asterisk (*) for wildcard matching.
Whether to truncate the logfile lines. Use 0 to not disable truncating, or specify a number to receive the last x lines. Defaults to 1000.
Required, in: extract, transform, prepare_report, proximity, chronos, pigeon, horizon, merlin, griffon
\n","type":"text/plain"},"key":"component","value":""},{"description":{"content":"Limit the maximum number of logfiles to return. Defaults to 100.
Optionally filter the logfiles by filename. Use the asterisk (*) for wildcard matching.
Whether to truncate the logfile lines. Use 0 to not disable truncating, or specify a number to receive the last x lines. Defaults to 1000.
Required, in: extract, transform, prepare_report, proximity, chronos, pigeon, horizon, merlin, griffon
\n","type":"text/plain"},"key":"component","value":"prepare_report"},{"description":{"content":"Limit the maximum number of logfiles to return. Defaults to 100.
Optionally filter the logfiles by filename. Use the asterisk (*) for wildcard matching.
Whether to truncate the logfile lines. Use 0 to not disable truncating, or specify a number to receive the last x lines. Defaults to 1000.
Exivity documentation: https://docs.exivity.com/troubleshooting/logs
\n","event":[{"listen":"prerequest","script":{"id":"554f307a-a334-451f-933e-b56eaaf9f78c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8628d104-ff0f-4447-8408-2e25a7880be3","type":"text/javascript","exec":[""]}}],"_postman_id":"313a1e46-93a6-4969-9035-58e814c3c171","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"/licence","item":[{"name":"Retrieve current licence","event":[{"listen":"test","script":{"id":"7c6742a6-e5fd-4bf6-8bb4-afabc86fd858","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('object');"," pm.expect(response.data.type).to.eql('licence');"," pm.expect(response.data.id).to.be.a('string');","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes.status).to.be.a('string');"," pm.expect(response.data.attributes.expiresAfter).to.be.a('string');","});",""],"type":"text/javascript"}}],"id":"ece59e75-952c-4629-8b91-66d5e48d82e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/licence","urlObject":{"path":["v2","licence"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e6230104-38a3-4cbf-aa84-8a56099b9e7e","name":"Retrieve current licence","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/licence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 11 Oct 2022 08:17:25 GMT"},{"key":"Date","value":"Tue, 11 Oct 2022 08:17:25 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xef4683655c2a2407f8ff100c7ca4e441"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xef4683655c2a2407f8ff100c7ca4e441"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-WXfBZm79sI3EuWzAWnOkww163LIbT1X6';style-src 'self' 'nonce-WXfBZm79sI3EuWzAWnOkww163LIbT1X6';font-src 'self' data:"},{"key":"Request-Id","value":"9b44b5e3-e7a2-4f98-9e2c-2c795b3ac522"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"licence\",\n \"id\": \"83b44524e07b8cb94f110010dd15fa82b352d1fa\",\n \"attributes\": {\n \"status\": \"valid\",\n \"expiresAfter\": \"2027-07-01\"\n }\n }\n}"}],"_postman_id":"ece59e75-952c-4629-8b91-66d5e48d82e2"},{"name":"Add new licence","event":[{"listen":"test","script":{"id":"523ab58c-9d44-4d77-98c2-29c337fb1c35","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response).to.be.an('object');"," pm.expect(response.data.type).to.eql('licence');"," pm.expect(response.data.id).to.be.a('string');","});","","pm.test(\"Response contains correct attributes\", function () {"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes.status).to.be.a('string');"," pm.expect(response.data.attributes.expiresAfter).to.be.a('string');","});",""],"type":"text/javascript"}}],"id":"d74d55b6-4e4c-474b-adef-ec36e782a7a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"licence\",\n \"id\": \"83b44524e07b8cb94f110010dd15fa82b352d1fa\",\n \"attributes\": {\n \"licence\": \"{{licence}}\"\n }\n }\n}"},"url":"{{base_url}}/v2/licence","description":"Adding a new licence will replace current licence.
\n","urlObject":{"path":["v2","licence"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e34ed073-f6f1-429b-9420-7b006385655d","name":"Add new licence","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"licence\",\n \"id\": \"83b44524e07b8cb94f110010dd15fa82b352d1fa\",\n \"attributes\": {\n \"licence\": \"123abc...\"\n }\n }\n}"},"url":"{{base_url}}/v2/licence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 11 Oct 2022 08:19:32 GMT"},{"key":"Date","value":"Tue, 11 Oct 2022 08:19:32 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xf554696a16cbf290bf623dd4db89710c"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xf554696a16cbf290bf623dd4db89710c"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-vVcXuyr108zUiCvf4jDhZQfdXAA4eRC8';style-src 'self' 'nonce-vVcXuyr108zUiCvf4jDhZQfdXAA4eRC8';font-src 'self' data:"},{"key":"Request-Id","value":"ab679167-947d-4c17-8ce2-db4167f3e9c9"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"licence\",\n \"id\": \"4062176ea1471472332ab3afbc2d5dc58af621b7\",\n \"attributes\": {\n \"status\": \"valid\",\n \"expiresAfter\": \"2023-01-31\"\n }\n }\n}"}],"_postman_id":"d74d55b6-4e4c-474b-adef-ec36e782a7a9"}],"id":"9d4762bb-3baa-447d-8250-242f048cbc79","description":"Atomic support:β
\nIn order to have a fully functional solution, you need a valid license.
\nExivity documentation: https://docs.exivity.com/licence
\nOptionally specify a component to delete the caches for. Available options: proximity, edify.
β οΈ This endpoint is deprecated and may be removed in future versions of Exivity. Use /system/version and /system/flags instead.
β οΈ This endpoint is deprecated and may be removed in future versions of Exivity. Use /system/version and /system/flags instead.
Lists the installed components in the Exivity system and their version information.
\n","urlObject":{"path":["v2","system","version"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"804a7645-6952-4ec9-a2fd-43b6dd6e5131","name":"Get version information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/system/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 24 May 2022 15:14:18 GMT"},{"key":"Date","value":"Tue, 24 May 2022 15:14:18 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X62d7d0e8584bf661ba0a123527bfc0a0"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X62d7d0e8584bf661ba0a123527bfc0a0"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-3b7DgH3Y3KMohdqArKCadQDg9wIOGqgO';style-src 'self' 'nonce-3b7DgH3Y3KMohdqArKCadQDg9wIOGqgO';font-src 'self' data:"},{"key":"Request-Id","value":"842f59b0-6330-4c40-b24c-e841c9a9ef90"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"version\": \"3.6.7\",\n \"components\": {\n \"exivityd\": {\n \"ref\": \"v1.0.0\",\n \"hash\": \"89747002f3daa264fd58782f820854414c2b71f9\"\n },\n \"db\": {\n \"ref\": \"v3.3.1\",\n \"hash\": \"7fbdfe1b51cd48da68e2b2a9d870dbf2fa9e83d6\",\n \"schema_version\": 20220211,\n \"data_migrations\": [\n \"WorkflowStepAttributes\",\n \"TierBreakdown\"\n ]\n },\n \"use\": {\n \"ref\": \"v3.1.6\",\n \"hash\": \"1e2df979ff00fc39823d559ca5b673f12521c9cf\"\n },\n \"transcript\": {\n \"ref\": \"v3.3.6\",\n \"hash\": \"06cdc47f2b8032780bb50e413b4020c216fb9d06\"\n },\n \"edify\": {\n \"ref\": \"v3.3.3\",\n \"hash\": \"3df5b4e51876e35cbad5a5911ba5b09aa96a6c35\"\n },\n \"glass\": {\n \"ref\": \"v2.4.7\",\n \"hash\": \"e6423e03c7869db6991f78579d87f1f41437ec15\"\n },\n \"proximity\": {\n \"ref\": \"v2.13.1\",\n \"hash\": \"febd77432caff702daa35a018d09d97cadf3eda9\",\n \"api\": \"v1\"\n },\n \"pigeon\": {\n \"ref\": \"v2.1.3\",\n \"hash\": \"768b5d08f1eb81dcd012f6c7a218dde8777725ac\"\n },\n \"horizon\": {\n \"ref\": \"v2.1.2\",\n \"hash\": \"a69ec0684bd038a845cb96552860a94dd642bfc7\"\n },\n \"merlin\": {\n \"ref\": \"v1.1.3\",\n \"hash\": \"6496074fef91934fae1318f65e56984c63f678ea\"\n },\n \"griffon\": {\n \"ref\": \"v1.0.3\",\n \"hash\": \"1361ec402bbe50af198ad4a03a40cb5e1971855b\"\n },\n \"bunny\": {\n \"ref\": \"v1.0.1\",\n \"hash\": \"057579f0def9e96bcc995992d3ffcd1b1b1c5b04\"\n },\n \"chronos\": {\n \"ref\": \"v1.0.4\",\n \"hash\": \"e789a1c6873346483f2947633191137d750d21da\"\n }\n }\n }\n}"}],"_postman_id":"bf7ba05e-9de1-499a-a048-cfa9e44d3d96"},{"name":"Get version information (unauthenticated)","event":[{"listen":"test","script":{"id":"2cfc8d10-92d8-4b91-9740-d4cb5ca936a4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('object');"," pm.expect(response.data).to.have.keys(["," \"version\""," ]);","});"],"type":"text/javascript"}}],"id":"f61a3dda-8e33-4820-97ca-3e6bd73f8370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Atomic support:β
\nThis endpoint lists all the third party licences used by different components in the Exivity system.
\n","urlObject":{"path":["v2","third-party-licences"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2be5000c-49ee-4799-b08c-41d1fd7afd12","name":"Get third party licences","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/third-party-licences"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 24 May 2022 15:06:57 GMT"},{"key":"Date","value":"Tue, 24 May 2022 15:06:57 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X9701f22f1d04b5a63cc80b3853a62eec"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X9701f22f1d04b5a63cc80b3853a62eec"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Feature-Policy","value":"autoplay 'none'; camera 'none'"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Content-Security-Policy","value":"base-uri 'self';connect-src 'self';default-src 'self';form-action 'self';img-src 'self' data:;media-src 'self';object-src 'none';script-src 'self' 'nonce-6LGrC4JLSSDhnZ1rngrPzZZAhW0UDQMO';style-src 'self' 'nonce-6LGrC4JLSSDhnZ1rngrPzZZAhW0UDQMO';font-src 'self' data:"},{"key":"Request-Id","value":"bdfc7450-3eaa-4b64-9f90-389a85458fac"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"third-party-licences\",\n \"id\": \"chronos\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"edify\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses..\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"griffon\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses..\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"horizon\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses..\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"merlin\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses..\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"transcript\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses..\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"use\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"db\",\n \"attributes\": {\n \"value\": \"# 3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"scaffold\",\n \"attributes\": {\n \"value\": \"#3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"pigeon\",\n \"attributes\": {\n \"value\": \"#3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"glass\",\n \"attributes\": {\n \"value\": \"#3rd Party licenses...\"\n }\n },\n {\n \"type\": \"third-party-licences\",\n \"id\": \"proximity\",\n \"attributes\": {\n \"value\": \"#3rd Party licenses...\"\n }\n }\n ]\n}"}],"_postman_id":"fbe40106-24d0-4fa4-a4a9-d766327aeb69"}],"id":"50d152b1-e9e3-4524-ba46-6a5e40aafb87","event":[{"listen":"prerequest","script":{"id":"a2675b58-3ea0-4597-9515-63b606a9e910","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b7bc8ea-6dee-4b27-a626-7aa9cff64870","type":"text/javascript","exec":[""]}}],"_postman_id":"50d152b1-e9e3-4524-ba46-6a5e40aafb87","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"/environments","item":[{"name":"Retrieve a list of environments","event":[{"listen":"test","script":{"id":"68af8af2-cd28-436a-a634-22c799de5e0c","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"341b51b0-4062-457e-bafe-3b58a501a9ee","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r",""],"type":"text/javascript"}}],"id":"0d52dab9-5c41-4b87-9924-34f68aafff93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/environments?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","environments"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: variables.
Include additional related resources. Possible values: variables.
Atomic support: βοΈ
\nEnvironments store global variables. An environment can be set as the default; variables defined in the default environment are also available in all other environments and can be overridden in each environment.
\nExivity documentation: https://docs.exivity.com/administration/settings/global-variables
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"9919e041-4c6d-4226-a82e-05ec59692b49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c84adf08-93e4-46f6-9d13-76e03a4edf0e","type":"text/javascript","exec":[""]}}],"_postman_id":"c8c3b647-5700-497a-b510-0fd81110b627","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"/variables","item":[{"name":"Retrieve a list of variables","event":[{"listen":"test","script":{"id":"d637e285-d3d3-45c4-a505-c051820dc7da","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('array');","});"],"type":"text/javascript"}}],"id":"ec3e5169-0d7f-4aa0-a2e3-0145129b4ca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v2/variables?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v2","variables"],"host":["{{base_url}}"],"query":[{"description":{"content":"Limit the amount of results returned
\n","type":"text/plain"},"key":"page[limit]","value":null},{"description":{"content":"Return this page of the results
\n","type":"text/plain"},"key":"page[offset]","value":null},{"description":{"content":"Sort results by this attribute
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: environment.
Include additional related resources. Possible values: environment.
Atomic support: βοΈ
\nGlobal Variables enable users to configure Exivity system-wide variables which can be used in any Extractor or Transformer script.
\nExivity documentation:
\nhttps://docs.exivity.com/architecture%20concepts/glossary/#environment
\nThe following relationships can be included:
\n","event":[{"listen":"prerequest","script":{"id":"94e0d128-9524-410f-a8b9-7c2bacf3220c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e01fa18d-8aa4-4272-a0b1-26e07d2662f5","type":"text/javascript","exec":[""]}}],"_postman_id":"4016ec02-e604-440c-9586-f6adb61a4d02","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"/failed-jobs","item":[{"name":"Get all failed jobs","id":"a337263a-6ea5-4824-87cb-f60beb12535e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v2/failed-jobs","urlObject":{"path":["v2","failed-jobs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a337263a-6ea5-4824-87cb-f60beb12535e"}],"id":"69c71bf7-1071-49e7-b8d6-73f702ccc318","_postman_id":"69c71bf7-1071-49e7-b8d6-73f702ccc318","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}},{"name":"Billing","item":[{"name":"/cuprs","item":[{"name":"Retrieve a list of CUPRs","event":[{"listen":"test","script":{"id":"7c02b33d-8731-4190-8efa-6ffe12b9d3a7","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('object');","});",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"d2b6e9b7-5348-4376-b9d3-47aaddf9c936","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });"],"type":"text/javascript"}}],"id":"231f6c75-219b-4f75-a2ec-963a6ddc9a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v2/cuprs","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}},"urlObject":{"path":["v2","cuprs"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Optionally filter the output by dset or months. Possible fields are [dset][], [start_month](Y-m), [end_month](Y-m). This parameter can occur multiple times in a request to filter by multiple dsets and combine them with the date range.
Atomic support: β
\nThe following relationships can be included:
\n","_postman_id":"2da384a1-7f21-4ea3-a3cb-bd6086786139","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}}],"id":"7075f4d8-e81d-4cb6-8383-b86485ff8c7c","_postman_id":"7075f4d8-e81d-4cb6-8383-b86485ff8c7c","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","name":"Administration","type":"folder"}}}],"id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3460a0b4-7fff-4413-b54c-a23878d041bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d31abe3c-f2a8-4f4e-87c7-a34682ad32db","type":"text/javascript","exec":[""]}}],"_postman_id":"1ca87589-5b4d-47c1-bae6-c833ca4567ae","description":""}],"event":[{"listen":"prerequest","script":{"id":"5bbe69ac-75dd-4a18-ba40-2a494083529f","type":"text/javascript","exec":["console.log('');","console.log('********************* ' + pm.info.requestName + '(v2) *********************');","","const helpers = () => {",""," const api = {};",""," // Generic helpers",""," let interval = 100; // check every x ms"," let max = 60000; // 1 minute",""," let started = false;"," let finished = false;"," let elapsed = 0;",""," function wait() {"," if (!finished && elapsed <= max) {"," setTimeout(wait, interval);"," elapsed += interval;"," }"," }",""," function promisify(fn) {"," return function (arg) {"," if (!started) {"," started = true;"," wait();"," }"," return new Promise(function (accept, reject) {"," fn(arg, function (err, res) {"," if (err) {"," reject(err);"," } else {"," accept(res);"," }"," });"," });",""," };"," }",""," api.asyncRequest = promisify(pm.sendRequest);",""," api.start = function () {"," console.log('---- Pre-request Script start ----');"," wait();"," return new Promise(function (accept, reject) {"," accept();"," });"," };",""," api.ready = function () {"," finished = true;"," console.log('---- Pre-request Script end ----');"," };",""," // Domain helpers"," api.requireToken = function () {"," console.log('requireToken()');",""," // Check if Token ID is set"," if (pm.environment.get(\"token\") && pm.environment.get(\"token\") !== 'undefined') {"," console.log('GET token: ' + pm.environment.get(\"token\"));"," return pm.environment.get(\"token\");"," }",""," // Check if username & password areset"," if (!pm.environment.get(\"username\") || !pm.environment.get(\"password\")) {"," throw new Error('Username or password not set');"," }",""," var details = {"," 'username': encodeURIComponent(pm.environment.get(\"username\")),"," 'password': encodeURIComponent(pm.environment.get(\"password\")),"," };"," var formBody = [];"," for (var property in details) {"," var encodedKey = encodeURIComponent(property);"," var encodedValue = encodeURIComponent(details[property]);"," formBody.push(encodedKey + \"=\" + encodedValue);"," }",""," // Generate token"," return api.asyncRequest({"," // Create a new token"," url: pm.variables.get(\"base_url\") + '/v2/auth/token?include=user',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/x-www-form-urlencoded'"," },"," body: formBody.join(\"&\")"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 200)) {"," throw new Error(response);"," }"," json = response.json();",""," pm.environment.set(\"token\", json.data.attributes.token);"," console.log('SET token: ' + pm.environment.get(\"token\"));"," pm.environment.set(\"user_id\", json.data.relationships.user.data.id);"," console.log('SET user_id: ' + pm.environment.get(\"user_id\"));",""," return pm.environment.get(\"token\");"," });"," };",""," api.requireReportDefinition = function () {"," console.log('requireReportDefinition()');",""," // Check if report defintion ID is set"," if (pm.environment.get(\"reportdefinition_id\") && pm.environment.get(\"reportdefinition_id\") !== 'undefined') {"," console.log('GET reportdefinition_id: ' + pm.environment.get(\"reportdefinition_id\"));"," return pm.environment.get(\"reportdefinition_id\");"," }",""," // Check Dset ID is set"," if (!pm.environment.get(\"dset_id\")) {"," throw new Error('Dset ID not set - need to create report');"," }",""," // Not set - create report defintion"," return api.asyncRequest({"," // Create a new report"," url: pm.variables.get(\"base_url\") + '/v2/reportdefinitions',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"reportdefinition\","," \"attributes\": {"," \"name\": \"Test report - \" + Math.floor(Math.random() * 1000),"," \"dset\": pm.variables.get(\"dset_id\"),"," \"level_keys\": ["," {"," \"key_column\": \"Country\","," \"name_column\": \"Country\","," \"label\": \"Country\","," \"level\": 1"," },"," {"," \"key_column\": \"Reseller\","," \"name_column\": \"Reseller\","," \"label\": \"Reseller\","," \"level\": 2"," },"," ]"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"reportdefinition_id\", json.data.id);"," console.log('SET reportdefinition_id: ' + pm.environment.get(\"reportdefinition_id\"));"," return pm.environment.get(\"reportdefinition_id\");"," });"," };",""," api.requireAccount = function (reportId) {"," console.log('reqireAccount()');",""," // Check if Account ID is set"," if (pm.environment.get(\"account_id\") && pm.environment.get(\"account_id\") !== 'undefined') {"," console.log('GET account_id: ' + pm.environment.get(\"account_id\"));"," return pm.environment.get(\"account_id\");"," }",""," // Not set - create account",""," // Check report definition ID"," if (!pm.environment.get(\"reportdefinition_id\")) {"," throw new Error('Report definition ID not set - need to create Account');"," }",""," return api.asyncRequest({"," // Create a new account"," url: pm.variables.get(\"base_url\") + '/v2/accounts',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"account\","," \"attributes\": {"," \"name\": \"Test account - \" + Math.floor(Math.random() * 1000),"," },"," \"relationships\": {"," \"reportdefinition\": {"," \"data\": {"," \"type\": \"reportdefinition\","," \"id\": pm.variables.get(\"reportdefinition_id\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"account_id\", json.data.id);"," console.log('SET account_id: ' + pm.environment.get(\"account_id\"));"," return pm.environment.get(\"account_id\");"," });"," };",""," api.requireBudget = function () {"," console.log('requireBudget()');",""," // Check if budget ID is set"," if (pm.environment.get(\"budget_id\") && pm.environment.get(\"budget_id\") !== 'undefined') {"," console.log('SET budget_id: ' + pm.environment.get(\"budget_id\"));"," return pm.environment.get(\"budget_id\");"," }",""," return api.asyncRequest({"," // Create a new budget"," url: pm.variables.get(\"base_url\") + '/v2/budgets',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"budget\","," \"attributes\": {"," \"interval\": \"year\","," \"description\": \"Test Budget - \" + Math.floor(Math.random() * 1000),"," \"metric\": \"cogs\""," },"," \"relationships\": {"," \"report\": {"," \"data\": {"," \"type\": \"report\","," \"id\": pm.variables.get(\"report_id\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"budget_id\", json.data.id);"," console.log('SET budget_id: ' + pm.environment.get(\"budget_id\"));"," return pm.environment.get(\"budget_id\");"," });"," };",""," api.requireBudgetRevision = function (budgetId) {"," console.log('requireBudgetRevision()');",""," // Check if budget ID is set"," if (pm.environment.get(\"budgetrevision_id\") && pm.environment.get(\"budgetrevision_id\") !== 'undefined') {"," console.log('SET budgetrevision_id: ' + pm.environment.get(\"budgetrevision_id\"));"," return pm.environment.get(\"budgetrevision_id\");"," }",""," return api.asyncRequest({"," // Create a new budget revision"," url: pm.variables.get(\"base_url\") + '/v2/budgetrevisions',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"budgetrevision\","," \"attributes\": {"," \"effective_from\": \"20190606\""," },"," \"relationships\": {"," \"budget\": {"," \"data\": {"," \"type\": \"budget\","," \"id\": pm.variables.get(\"budget_id\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"budgetrevision_id\", json.data.id);"," console.log('SET budgetrevision_id: ' + pm.environment.get(\"budgetrevision_id\"));"," return pm.environment.get(\"budgetrevision_id\");"," });"," };",""," api.requireService = function () {"," console.log('requireService()');",""," // Check if service ID is set"," if (pm.environment.get(\"service_id\") && pm.environment.get(\"service_id\") !== 'undefined') {"," console.log('SET service_id: ' + pm.environment.get(\"service_id\"));"," return pm.environment.get(\"service_id\");"," }",""," // Check Dset ID is set"," if (!pm.environment.get(\"dset_id\")) {"," throw new Error('Dset ID not set - need to create service');"," }",""," return api.asyncRequest({"," // Create a new service"," url: pm.variables.get(\"base_url\") + '/v2/services',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"service\","," \"attributes\": {"," \"key\": \"Test Service - \" + Math.floor(Math.random() * 1000),"," \"description\": \"test service\","," \"unit_label\": \"hours\","," \"dset\": pm.variables.get(\"dset_id\"),"," \"type\": \"service_name_in_header\","," \"usage_col\": \"unique_key\","," \"consumption_col\": \"quantity\","," \"instance_col\": \"hostname\","," \"interval\": \"individually\","," \"charge_type\": \"manual_per_unit\","," \"cogs_type\": \"none\","," \"proration_type\": \"full\","," \"charge_model\": \"peak\""," },"," \"relationships\": {"," \"servicecategory\": {"," \"data\": {"," \"type\": \"servicecategory\","," \"id\": pm.variables.get(\"servicecategory_id\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"service_id\", json.data.id);"," console.log('SET service_id: ' + pm.environment.get(\"service_id\"));"," return pm.environment.get(\"service_id\");"," });"," };",""," api.requireServiceCategory = function () {"," console.log('requireServiceCategory()');",""," // Check if service category ID is set"," if (pm.environment.get(\"servicecategory_id\") && pm.environment.get(\"servicecategory_id\") !== 'undefined') {"," console.log('SET servicecategory_id: ' + pm.environment.get(\"servicecategory_id\"));"," return pm.environment.get(\"servicecategory_id\");"," }",""," return api.asyncRequest({"," // Create a new service category"," url: pm.variables.get(\"base_url\") + '/v2/servicecategories',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"servicecategory\","," \"attributes\": {"," \"name\": \"Test Service Category - \" + Math.floor(Math.random() * 1000),"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"servicecategory_id\", json.data.id);"," console.log('SET servicecategory_id: ' + pm.environment.get(\"servicecategory_id\"));"," return pm.environment.get(\"servicecategory_id\");"," });"," };",""," api.requireRate = function () {"," console.log('requireRate()');",""," // Check if rate ID is set"," if (pm.environment.get(\"rate_id\") && pm.environment.get(\"rate_id\") !== 'undefined') {"," console.log('SET rate_id: ' + pm.environment.get(\"rate_id\"));"," return pm.environment.get(\"rate_id\");"," }",""," // Check service ID"," if (!pm.environment.get(\"service_id\")) {"," throw new Error('Service ID not set - need to create rate');"," }",""," return api.asyncRequest({"," // Create a new rate"," url: pm.variables.get(\"base_url\") + '/v2/rates',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"rate\","," \"attributes\": {"," \"rate\": \"1.0\","," \"rate_col\": \"rate_col\","," \"fixed\": \"2.0\","," \"fixed_col\": \"fixed_col\","," \"cogs_rate\": \"3.0\","," \"cogs_rate_col\": \"cogs_rate_col\","," \"cogs_fixed\": \"4.0\","," \"cogs_fixed_col\": \"cogs_fixed_col\","," \"effective_date\": \"2017-08-27\""," },"," \"relationships\": {"," \"service\": {"," \"data\": {"," \"type\": \"service\","," \"id\": pm.variables.get(\"service\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"rate_id\", json.data.id);"," console.log('SET rate_id: ' + pm.environment.get(\"rate_id\"));"," return pm.environment.get(\"rate_id\");"," });"," };",""," api.requireWorkflow = function () {"," console.log('requireWorkflow()');",""," // Check if ID is already set"," if (pm.environment.get(\"workflow_id\") && pm.environment.get(\"workflow_id\") !== 'undefined') {"," console.log('GET workflow_id: ' + pm.environment.get(\"workflow_id\"));"," return pm.environment.get(\"workflow_id\");"," }",""," return api.asyncRequest({"," // Create a new budget"," url: pm.variables.get(\"base_url\") + '/v2/workflows',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"workflow\","," \"attributes\": {"," \"name\": \"Test workflow\" + Math.floor(Math.random() * 1000),"," \"description\": \"This is test task\","," \"hidden\": false"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"workflow_id\", json.data.id);"," console.log('SET workflow_id: ' + pm.environment.get(\"workflow_id\"));"," return pm.environment.get(\"workflow_id\");"," });"," };",""," api.requireWorkflowExecuteStep = function () {"," console.log('requireWorkflowExecuteStep()');",""," // Check if ID is already set"," if (pm.environment.get(\"execute_workflowstep_id\") && pm.environment.get(\"execute_workflowstep_id\") !== 'undefined') {"," console.log('GET execute_workflowstep_id: ' + pm.environment.get(\"execute_workflowstep_id\"));"," return pm.environment.get(\"execute_workflowstep_id\");"," }",""," return api.asyncRequest({"," // Create a new budget"," url: pm.variables.get(\"base_url\") + '/v2/workflowsteps',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"workflowstep\","," \"attributes\": {"," \"type\": \"execute\","," \"sort\": 1,"," \"timeout\": 600,"," \"options\": {"," \"command\": \"echo \\\"testing\\\"\""," }"," },"," \"relationships\": {"," \"workflow\": {"," \"data\": {"," \"type\": \"workflow\","," \"id\": pm.variables.get(\"workflow_id\")"," }"," }"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"execute_workflowstep_id\", json.data.id);"," console.log('SET execute_workflowstep_id: ' + pm.environment.get(\"execute_workflowstep_id\"));"," return pm.environment.get(\"execute_workflowstep_id\");"," });"," };",""," api.runWorkflow = function () {"," console.log('runWorkflow()');",""," // Check Workflow ID is set"," if (!pm.environment.get(\"workflow_id\")) {"," throw new Error('Can\\'t run workflow - Workflow ID not set');"," }",""," return api.asyncRequest({"," url: pm.variables.get(\"base_url\") + '/v2/workflows/' + pm.environment.get(\"workflow_id\") + '/run',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 200)) {"," throw new Error(response);"," }"," });"," };",""," api.requireEnvironment = function () {"," console.log('requireEnvironment()');",""," // Check if service category ID is set"," if (pm.environment.get(\"environment_id\") && pm.environment.get(\"environment_id\") !== 'undefined') {"," console.log('SET environment_id: ' + pm.environment.get(\"environment_id\"));"," return pm.environment.get(\"environment_id\");"," }",""," return api.asyncRequest({"," // Create a new service category"," url: pm.variables.get(\"base_url\") + '/v2/environments',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"environment\","," \"attributes\": {"," \"name\": \"Test Environment - \" + Math.floor(Math.random() * 1000),"," \"default_flag\": false"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"environment_id\", json.data.id);"," console.log('SET environment_id: ' + pm.environment.get(\"environment_id\"));"," return pm.environment.get(\"environment_id\");"," });"," };",""," api.requireMetadataDefinition = function () {"," console.log('requireMetadataDefinition()');",""," // Check if metadatadefinition ID is set"," if (pm.environment.get(\"metadatadefinition_id\") && pm.environment.get(\"metadatadefinition_id\") !== 'undefined') {"," console.log('SET metadatadefinition_id: ' + pm.environment.get(\"metadatadefinition_id\"));"," return pm.environment.get(\"metadatadefinition_id\");"," }",""," return api.asyncRequest({"," // Create a new metadata definition"," url: pm.variables.get(\"base_url\") + '/v2/metadatadefinitions',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"metadatadefinition\","," \"attributes\": {"," \"name\": \"Test definition - \" + Math.floor(Math.random() * 1000),"," \"fields\": ["," {"," \"name\": \"country\","," \"type\": \"string\""," }"," ]"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"metadatadefinition_id\", json.data.id);"," console.log('SET metadatadefinition_id: ' + pm.environment.get(\"metadatadefinition_id\"));"," return pm.environment.get(\"metadatadefinition_id\");"," });"," };",""," api.requireUsergroup = function () {"," console.log('requireUsergroup()');",""," // Check if usergroup ID is set"," if (pm.environment.get(\"usergroup_id\") && pm.environment.get(\"usergroup_id\") !== 'undefined') {"," console.log('SET usergroup_id: ' + pm.environment.get(\"usergroup_id\"));"," return pm.environment.get(\"usergroup_id\");"," }",""," return api.asyncRequest({"," // Create a new usergroup"," url: pm.variables.get(\"base_url\") + '/v2/usergroups',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"usergroup\","," \"attributes\": {"," \"name\": \"Usergroup - \" + Math.floor(Math.random() * 1000),"," \"permissions\": [\"manage_users\"]"," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"usergroup_id\", json.data.id);"," console.log('SET usergroup_id: ' + pm.environment.get(\"usergroup_id\"));"," return pm.environment.get(\"usergroup_id\");"," });"," };",""," api.requireDset = function () {"," console.log('requireDset()');",""," // Check if usergroup ID is set"," if (pm.environment.get(\"dset_id\") && pm.environment.get(\"dset_id\") !== 'undefined') {"," console.log('SET dset_id: ' + pm.environment.get(\"dset_id\"));"," return pm.environment.get(\"dset_id\");"," }",""," return api.asyncRequest({"," // Retrieve a list of datasets and use first one"," url: pm.variables.get(\"base_url\") + '/v2/dsets',"," method: 'GET',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 200)) {"," throw new Error(response);"," }"," json = response.json();"," if (!pm.expect(json.data).to.not.be.empty) {"," throw new Error(response);"," }"," pm.environment.set(\"dset_id\", json.data[0].id);"," console.log('SET dset_id: ' + pm.environment.get(\"dset_id\"));"," return pm.environment.get(\"dset_id\");"," });"," };",""," // Export everything"," return api;","};","","pm.globals.set('exivity', helpers.toString());"]}},{"listen":"test","script":{"id":"03e73c0f-4215-4670-9547-a4011195b742","type":"text/javascript","exec":[""]}}],"variable":[{"key":"component","value":"use"}]}