![](\"favicon.png\")
This 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.
\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\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"},{"id":"988057cc-9979-4c80-ae39-055fe05bae1c","name":"Power-on self-test - JSON response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base_url}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 Jan 2023 13:27:44 GMT"},{"key":"Date","value":"Mon, 09 Jan 2023 13:27:44 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Clockwork-Id","value":"X7574be9668bd804d63540673a3778baa"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X7574be9668bd804d63540673a3778baa"},{"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-GcXPDxDVPvlZVzRg6hxq4YsvDMi65YWb';style-src 'self' 'nonce-GcXPDxDVPvlZVzRg6hxq4YsvDMi65YWb';font-src 'self' data:"},{"key":"Request-Id","value":"bec46c98-d7be-43ea-8b60-372572c423d1"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6Imo3TFFmWHFVYUN0Q0JHenY3UVJrL2c9PSIsInZhbHVlIjoiUS9NaXovelViSThNSjVTOXFWK2FUa2k0T2xjSmlKcnRvU1BmTlBxSlN1cVZRU3krNnpzLzFBTGlBNVYxVVA4NGlDYmwrUUNyQVVFMnNrWTliOGMxZmhjSUZyTi9JVTZ2a055QjJYZ0tDcG5OZGJzYlRhTWVBMU83SnBYT09Id0ciLCJtYWMiOiIyMjVlNWZiMDhjYTFmZjliYmUyM2YxMjgzMjhjMDk2MmVkN2RlNjgzMTg1NDVlY2U1MTU2NjU3YzE4NmRjMDFlIiwidGFnIjoiIn0%3D; expires=Mon, 09 Jan 2023 15:27:44 GMT; Max-Age=7200; path=/; samesite=lax"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlplRXNvZ2VsK2h2R0JHd1lRalZiN2c9PSIsInZhbHVlIjoiNENCSUZQNHY1MkthMmRyWE5IVURkVEZGMjZmYk8wbUl4a1hiODBOODdLRVRnQmdTbThJQmQ2UFRPL1hrblg2YWMzQW1vRG5yOTFsaDg5d1pPUGFra0dncG9nV0tlMnBRUW02WVNlNGFwcXJCZXhwSEhmdFBEVVJiMVQ3WEUwYVEiLCJtYWMiOiI1YjMwMDc4NWQyZDE0ZjUxYzZlZTYxNzNmZDcwMzAyN2RjYjBhNmEyZjg1ZTQyODBjYzc0YTRmMDQzMDYyYTZmIiwidGFnIjoiIn0%3D; expires=Mon, 09 Jan 2023 15:27:44 GMT; Max-Age=7200; path=/; httponly; samesite=lax"},{"key":"Set-Cookie","value":"bIEYZP21mqjNDnAgsTe1sk4ETsxk3zeqbQhkGJpz=eyJpdiI6IldvbTViajNJNEFXVTdlUFR2NFI1L2c9PSIsInZhbHVlIjoiUVlIcEdUY0FTc0J5R2wxZ3djc3JjN2hDSmd6TTQ2NGFUYkE3QXp6ZU5PdnZvdHMwT1dJRUtEZ1J4Z1MxMWxEVlN5eWd0WW9IcVJQQTBmRWNtMXRzT3Z4RUpGOUtlZG9qNHArR0RBZzk1dWNxSkk5c2V3RXhFakZibkVWQVZZcWxuaFJvRlhnR3lJc0l5ZFdiNHZaZTRLMU1CejBjcVJiSDRqT3NxcHd0OHVhK29hWjBmeko4UmpMamR5bTFVYytQOTVvVVcrK1JCTDU4YVFYNzZlNXJjMHFqOURndjVId21uVURqallodEZOZlBzSndLZmEydjJNRUM0WnlyVzlXc3hhbUFJRE1QYmhCaUhUTnNmY3pDZXFzNFVVRDFzNk1wMzlVYjFjdUQ3d3dhaTJaUCtTeVZ4YUFSOG45bVhjWEZvMUlRRG5SZDh0NUxOcjhBeVYrbk5iOXFnMHVvV0xrTlJnWm84UlZDRndJPSIsIm1hYyI6IjdmMDVjZTVhMmJjOTU3YmNmODczNzcwMzUyMDU0MmMyNmUxY2RkNDc5YWQ1MmExNmJhZDcxMTcwNTQzODNlYmYiLCJ0YWciOiIifQ%3D%3D; expires=Mon, 09 Jan 2023 15:27:44 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":null},{"id":"f026854e-3ab3-4f1a-81b1-4193eceb97d8","name":"Power-on self-test - JSON response with error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{base_url}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 Jan 2023 13:21:50 GMT"},{"key":"Date","value":"Mon, 09 Jan 2023 13:21:50 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X091fff584dd0837c66e0d8e945feabc9"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X091fff584dd0837c66e0d8e945feabc9"},{"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-p8Dp4cU467ZKsv1akFNtUEwVyHEgfkjx';style-src 'self' 'nonce-p8Dp4cU467ZKsv1akFNtUEwVyHEgfkjx';font-src 'self' data:"},{"key":"Request-Id","value":"8f28487f-effe-4485-8ceb-f0c3948b0932"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlZ0M25INUt3eFlLU0FFc05nWENVRkE9PSIsInZhbHVlIjoiSkhNUHdlL2ZPSzNlNVE1RGE4QWsrYkNWY2F2MFJhQ2NoQ242LzZYdDNWYjlGNHg4ODIyaHU3SFppbDFidkJEWXRZV1FhYUt4SllnWldIV2ovN1h4S1dTNC9WUFlsMFgwaEJmSXl6MFpqK09CbnBuaUVLSjBSWFFIVVJVamJaUjAiLCJtYWMiOiI1MDBkOGJmM2MzODM0MTIzMTAyYmVhOGE4NWJmYTgwMTg0ZGY1ZTcyNDMzNWRhZGQ4MzU4OWQzNDRmNmNkYWYyIiwidGFnIjoiIn0%3D; expires=Mon, 09 Jan 2023 15:21:50 GMT; Max-Age=7200; path=/; samesite=lax"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Ikp4eENVR24vZlU0alZmOWRydkVRbUE9PSIsInZhbHVlIjoiWEFXYU1WTjFDQXQ1OEY3UEhWZjJyWDMrbVVYUy9FS0FyVjlHbEJhODBUaDF1QzJvODQ3Q3A0cTVLQUZPdUIwbWpQQS94MFRvOVNPaURZczQ3dHUxL1BQZVp5aFdvQUxSMCswRGJaYzU3Q1QrYmMybXovMklGUklneXdia1l6RHMiLCJtYWMiOiI0MDRkYmFjZGUwZDI3ODAxY2Y2MjVmM2UwOGU1OWJhYTQwOWIyZThmZTRlZmMwOWUxZGNkZDc4NTZhOTEzNTI1IiwidGFnIjoiIn0%3D; expires=Mon, 09 Jan 2023 15:21:50 GMT; Max-Age=7200; path=/; httponly; samesite=lax"},{"key":"Set-Cookie","value":"bIEYZP21mqjNDnAgsTe1sk4ETsxk3zeqbQhkGJpz=eyJpdiI6IkkrU1B6NkpSdHZvN2JnTE9TTytJTnc9PSIsInZhbHVlIjoicHEwb0xOU3Fua2paYncxMXlUQjlBTnE5cENHd3R2MS90aDdqakhjNnl5dDlQYTM5REIwNVBleUNxNzU4Qjd0dms2TDJKTS9iN0g2L0I1MGUycFVlcVlkOWhhaU10a0toWW1Ja055ckZrbWwzTjNMUWZBN0hHVy85WDBqSitqaS9seDFaNWFTNVpIT2Z5OHdjckRndC9CN0dGbXdBRWNKNmI3ZXE5OXdIeFY4YXkvT2h2R1o0b2RJdzVLYmdwMHdWZWJuWGdtY1JLZE9pOURRcFZYMmtBODJoQ2FMMG0wSzhjZmJLbEdIbUFQRmdCODdtd0kwZzcvbTdGZDFZQ0oyU0FlUzhSeXJPTnY5c0swZEVueHoxL1dCVkpsWmd5UlBlQTNHNXRUSXVncDZPZU1kWUNzM2xFZTNyS2NWUURhM1FyclRFU0c1elZvK3BPM21XdE5Rb2JvbUlKOExzTncwbDNtS3lERkorSmFZPSIsIm1hYyI6ImFhZjlhMDA1MmRjM2EwODdjMTEzMmIyYzA4YjJmNGIxMmQxZjVhNjA1ZGQ1ZWE2NzFkYzg2YTE1ZTc3OWUzODMiLCJ0YWciOiIifQ%3D%3D; expires=Mon, 09 Jan 2023 15:21:50 GMT; Max-Age=7200; path=/; httponly; samesite=lax"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"0\": {\n \"status\": 500,\n \"title\": \"InternalException\",\n \"detail\": \"There appears to be a problem with the system set-up. Please check the log files for more information.\"\n },\n \"meta\": {\n \"postgres\": true,\n \"environment\": false,\n \"home_dir\": true,\n \"program_dir\": true\n }\n }\n}"}],"_postman_id":"ee525104-747b-8c3a-4a6f-5853b45997e6"}],"id":"1bbfcc7f-775f-4019-b176-9a24d32af6b8","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"61672f73-3d08-4529-8039-f719d056ebc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"429c59a6-6069-4d92-847f-dcf095fc3d1a","type":"text/javascript","exec":[""]}}],"_postman_id":"1bbfcc7f-775f-4019-b176-9a24d32af6b8","description":""},{"name":"Authentication","item":[{"name":"/token","item":[{"name":"Generate token","event":[{"listen":"test","script":{"id":"bcf44e31-6f3e-4e8d-9237-74cca4029f54","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.token).to.be.a('string');","});","","pm.test(\"Response contains user\", function () {"," pm.expect(response.user).to.be.an('object');"," pm.expect(response.user.id).to.not.be.undefined;"," pm.expect(response.user.username).to.eql(\"admin\");"," pm.expect(response.user).to.have.property('email_address');"," pm.expect(response.user).to.have.property('account_access_type');","});","","pm.test(\"Response contains permissions\", function () {"," pm.expect(response.permissions).to.be.an('array')"," pm.expect(response.permissions).to.eql([\"*\"]);","});","","pm.environment.set(\"token\", response.token);","console.log('SET token: ' + pm.environment.get(\"token\"));","pm.environment.set(\"user_id\", response.user.id);","console.log('SET user_id: ' + pm.environment.get(\"user_id\"));"],"type":"text/javascript","packages":{}}}],"id":"5fe398a6-75d1-fa71-244b-5228aedd5809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"
string
\n","key":"username","type":"text","value":"{{username}}","warning":""},{"description":"string
\n","key":"password","type":"text","value":"{{password}}","warning":""}]},"url":"{{base_url}}/v1/auth/token","description":"Generate a new JWT authentication token.
\n","urlObject":{"path":["v1","auth","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"90177062-0538-4809-b674-0ba9e5be1ade","name":"Generate token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"string","key":"username","type":"text","value":"{{username}}","warning":""},{"description":"string","key":"password","type":"text","value":"{{password}}","warning":""}]},"url":"{{base_url}}/v1/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.4"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.3.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 18 Dec 2019 15:00:14 GMT"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzY2ODEyMTMsImV4cCI6MTU3NzI4NjAxMywidXNlciI6IjVmNDg1NzU1LTFiZTItNDBjNS05ZGIwLWFmZTcxMDFlOTg0OSJ9.az7bIkGHzmKN0rJzNvRBwmCApyxytly4jiC5igtzeH4\",\n \"user\": {\n \"id\": \"5f485755-1be2-40c5-9db0-afe7101e9849\",\n \"username\": \"admin\",\n \"email_address\": \"somebody@example.com\",\n \"account_access_type\": \"1\",\n \"source\": \"local\"\n },\n \"permissions\": [\n \"*\"\n ]\n}"}],"_postman_id":"5fe398a6-75d1-fa71-244b-5228aedd5809"},{"name":"Refresh token","event":[{"listen":"test","script":{"id":"c2941f4d-1136-48a9-8b5c-fbba812d3212","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.token).to.be.a('string');","});","","pm.test(\"Response contains user\", function () {"," pm.expect(response.user).to.be.an('object');"," pm.expect(response.user.id).to.not.be.undefined;"," pm.expect(response.user.username).to.eql(\"admin\");"," pm.expect(response.user).to.have.property('email_address');"," pm.expect(response.user).to.have.property('account_access_type');","});","","pm.test(\"Response contains permissions\", function () {"," pm.expect(response.permissions).to.be.an('array')"," pm.expect(response.permissions).to.eql([\"*\"]);","});"],"type":"text/javascript"}}],"id":"d73504ac-1cc6-2ea6-7463-b35fd00bf698","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":"urlencoded","urlencoded":[]},"url":"{{base_url}}/v1/auth/token","urlObject":{"path":["v1","auth","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c9742e18-74f1-4acf-b527-7c330d2ef1d2","name":"Refresh token","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{base_url}}/v1/auth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 31 Jan 2022 13:15:33 GMT"},{"key":"Date","value":"Mon, 31 Jan 2022 13:15:33 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X757c37d4a2946abcf6494169d55c2f18"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X757c37d4a2946abcf6494169d55c2f18"},{"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-69WXbqhdNLZ0fKilJnTktWxDdMHIm93e';style-src 'self' 'nonce-69WXbqhdNLZ0fKilJnTktWxDdMHIm93e';font-src 'self' data:"},{"key":"Request-Id","value":"74cb7eb3-6ff2-45c2-86e2-3c26b3f87ff2"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDM2MzQ5MzMsImV4cCI6MTY0MzY0OTMzMywidXNlciI6ImU3N2UzZjkwLTY3NjQtNGM2NS05NTIxLWRhNzBjYzkwMDFhOCIsImZpbmdlcnByaW50IjoiZTE2NjIzYmU4YmYxNjhhYjYyYmRkNWFjZTVmYWU5ODNjNjdhNjZkYSJ9.b3kVFuWumyvtfhan9bP7nguQaZ9g3B2ra1O0UtBnQsE\",\n \"user\": {\n \"id\": \"e77e3f90-6764-4c65-9521-da70cc9001a8\",\n \"username\": \"admin\",\n \"email_address\": \"somebody@example.com\",\n \"account_access_type\": \"all\",\n \"source\": \"local\",\n \"display_name\": \"admin\"\n },\n \"permissions\": [\n \"*\"\n ]\n}"}],"_postman_id":"d73504ac-1cc6-2ea6-7463-b35fd00bf698"},{"name":"Revoke token","event":[{"listen":"test","script":{"id":"c2941f4d-1136-48a9-8b5c-fbba812d3212","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET token');","pm.environment.unset(\"token\");"],"type":"text/javascript"}}],"id":"e41f4517-3a0d-43b1-a20c-bf54c3640822","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v1/auth/token","description":"On success, a HTTP 204 No Content success status response will be returned.
⚠️ Available since v3.0.0
\n","urlObject":{"path":["v1","auth","token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47d71db6-4774-432c-8d31-87d430d518c7","name":"Revoke token","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/auth/token"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 31 Jan 2022 14:06:35 GMT"},{"key":"Date","value":"Mon, 31 Jan 2022 14:06:35 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Clockwork-Id","value":"X0e9d312509bc68d6c95f0bc048d4e5a7"},{"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-zNqUj6Ll5GNyUIITJOa14aHiK61lvZzn';style-src 'self' 'nonce-zNqUj6Ll5GNyUIITJOa14aHiK61lvZzn';font-src 'self' data:"},{"key":"Request-Id","value":"c6f38885-93a3-41b6-9037-de99639dcad3"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e41f4517-3a0d-43b1-a20c-bf54c3640822"}],"id":"9579f7a2-499c-4082-8370-f2dafb272b86","description":"Exivity documentation: https://docs.exivity.com/Security/Authentication/Token
\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":["v1","auth","saml","login"],"host":["{{base_url}}"],"query":[{"key":"return_url","value":""}],"variable":[]}},"response":[],"_postman_id":"a0ea510b-cd3e-400d-9bb3-55f47ebd145a"},{"name":"Initiate SAML logout request","id":"1675fe0c-bc8e-49e4-9bba-29e3d701db78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/auth/saml/logout?return_url","description":"Redirects 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","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"043cebd0-bc7b-4b2d-a4a8-4c2b8a6ea284","id":"043cebd0-bc7b-4b2d-a4a8-4c2b8a6ea284","name":"/saml","type":"folder"}},"urlObject":{"path":["v1","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":"1675fe0c-bc8e-49e4-9bba-29e3d701db78"},{"name":"Entity ID endpoint","id":"f197a6ea-5e9e-416e-a072-1a5a282341ca","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/auth/saml/metadata","description":"Metadata about the SAML Service Provider instance will be published at this URL.
\n","urlObject":{"path":["v1","auth","saml","metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f197a6ea-5e9e-416e-a072-1a5a282341ca"},{"name":"ACS endpoint","id":"c8fac917-2339-4e12-bc12-33d6de4634c8","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/auth/saml/acs","description":"Assertion Consumer Service. If the received response from the SAML Identity Provider is valid, redirects to the Exivity dashboard.
\n","urlObject":{"path":["v1","auth","saml","acs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8fac917-2339-4e12-bc12-33d6de4634c8"},{"name":"SLS endpoint","id":"e2242d8d-f721-4a1a-9145-6828024f3db6","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/auth/saml/sls","description":"Single Logout Service. If the received response from the SAML Identity Provider is valid, redirects back to the login screen of Exivity.
\n","urlObject":{"path":["v1","auth","saml","sls"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2242d8d-f721-4a1a-9145-6828024f3db6"}],"id":"043cebd0-bc7b-4b2d-a4a8-4c2b8a6ea284","description":"Endpoints for supporting Single Sign-On authentication flow using SAML.
\nExivity documentation: https://docs.exivity.com/Security/Authentication/SAML2
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"59354d4f-9f3b-4067-82c8-f0090b22b9f8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"762c2a5c-93cb-4daa-a67f-8017c16bc2c3","type":"text/javascript","exec":[""]}}],"_postman_id":"043cebd0-bc7b-4b2d-a4a8-4c2b8a6ea284"},{"name":"/resetpassword","item":[{"name":"Request a password reset","event":[{"listen":"test","script":{"id":"bbf15994-f0c0-451f-a827-6ed83922cdc3","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"5a1783b8-2070-4c41-b866-e58a93a42cee","exec":[""],"type":"text/javascript"}}],"id":"d0daa6e8-b159-4525-ba2a-583577986ad9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email_address\": \"somebody@example.com\"\n}"},"url":"{{base_url}}/v1/auth/resetpassword","description":"This 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.
This request validates the reset token and username, and then resets a users password.
\nOn success, a HTTP 204 No Content success status response will be returned.
If a user forgets their password, this endpoint can be used to generate a new password. There are two steps:
\nTest authentication is working correctly. If should reply with pong if all is correct.
The 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},"_postman_id":"e68dba12-e43f-67cf-02f7-252b44cb3b44"},{"name":"Reports","item":[{"name":"/reports","item":[{"name":"Retrieve a list of report definitions","event":[{"listen":"test","script":{"id":"73508453-93c1-4470-b6a4-d9615e7362f1","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":"aa78fa43-2539-479e-8f2e-ac345788c196","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":"cf7443a1-e6f5-1861-7f3b-347b1ec199bd","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}}/v1/reports?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","reports"],"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":"Optionally filter results by this attribute.
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: accounts, metadatadefinitions, dset, budgets.
Report ID
\n","type":"text/plain"},"type":"string","value":"{{report_id}}","key":"report_id"}]}},"response":[],"_postman_id":"2659dc88-c22f-037f-a429-e8793a98d95c"},{"name":"Update a report definition","event":[{"listen":"test","script":{"id":"89393b2c-382c-46e2-ae4f-daa9135865f2","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('report');"," 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\"name\": \"Modified test report\","," \"dset\": pm.environment.get(\"dset_id\"),"," \"depth\": 2","\t});"," pm.expect(response.data.attributes.created).to.be.a('string');"," pm.expect(response.data.attributes.last_updated).to.be.a('string');"," pm.expect(response.data.attributes.data_status).to.be.an('object');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"4d7a089e-b21e-791f-30aa-5e39979006ac","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\t\"data\": {\r\n\t\t\"type\": \"report\",\r\n\t\t\"id\": \"{{report_id}}\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"Modified test report\"\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/reports/{{report_id}}","urlObject":{"path":["v1","reports","{{report_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d7a089e-b21e-791f-30aa-5e39979006ac"},{"name":"Prepare a report","event":[{"listen":"test","script":{"id":"8dab42c7-d268-4337-869f-b528743b4a56","exec":["var response = {};","","for (let i of responseBody.split('\\n')) {"," if (i[0] === '{') {"," response = JSON.parse(i);"," }","}","","tests[\"Response contains sync_accounts array\"] = typeof response.sync_accounts === 'object';","tests[\"Response contains prepare_report array\"] = typeof response.prepare_report === 'object';"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"574ea6a1-88b7-4a94-9408-fb37e90a7a90","exec":["pm.environment.set(\"start\", \"20170825\");","pm.environment.set(\"end\", \"20170827\");",""],"type":"text/javascript"}}],"id":"149af3f1-91d2-d51e-5ef0-6272664d21b3","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":"urlencoded","urlencoded":[]},"url":"{{base_url}}/v1/reports/:report_id/prepare?start={{start}}&end={{end}}","urlObject":{"path":["v1","reports",":report_id","prepare"],"host":["{{base_url}}"],"query":[{"description":{"content":"The start of the date range (inclusive) you want to prepare the report for in YYYY-MM-DD format.
The end of the date range (inclusive) you want to prepare the report for in YYYY-MM-DD format.
⚠️ The filter[parent_account_id] is deprecated. Please use filter[account_id] instead.
The output format when either json or csv is selected as the format parameter:
The output format of the embedded adjustments data:
\nThe output format of the embedded daily breakdown data:
\nThe output format of the embedded tier breakdown data:
\n","urlObject":{"path":["v1","reports",":report_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 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.
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":"{{report_id}}","key":"report_id"}]}},"response":[{"id":"54f1413a-cb1e-4791-86b6-003ea0dc6f1c","name":"Run a report","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/v1/reports/1/run?start=20170101&end=20231231","host":["{{base_url}}"],"path":["v1","reports","1","run"],"query":[{"key":"start","value":"20170101","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":"20231231","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."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 Oct 2023 08:28:48 GMT"},{"key":"Date","value":"Mon, 09 Oct 2023 08:28:48 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X126a7fdd74fff7f092bd0d9414b05159"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X126a7fdd74fff7f092bd0d9414b05159"},{"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-47VAq3vYoEQfUgzAPB5sphguIfMzipJB';style-src 'self' 'nonce-47VAq3vYoEQfUgzAPB5sphguIfMzipJB';font-src 'self' data:"},{"key":"Request-Id","value":"14a0cfad-632d-40d9-b57e-9d249b302f18"}],"cookie":[],"responseTime":null,"body":"{\n \"report\": [\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"13.000000\",\n \"total_quantity\": \"13.000000\",\n \"unit_based_subtotal_charge\": \"32.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"32.50\",\n \"total_charge\": \"32.50\",\n \"total_cogs\": \"28.60\",\n \"total_net\": \"3.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\": \"20170825\",\n \"account_id\": \"1\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"6.000000\",\n \"total_quantity\": \"6.000000\",\n \"unit_based_subtotal_charge\": \"7.20\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"7.20\",\n \"total_charge\": \"7.20\",\n \"total_cogs\": \"4.80\",\n \"total_net\": \"2.40\",\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\": \"1\",\n \"service_id\": \"72\",\n \"servicecategory_id\": \"53\"\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\": \"1\",\n \"service_id\": \"73\",\n \"servicecategory_id\": \"54\"\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\": \"1\",\n \"service_id\": \"74\",\n \"servicecategory_id\": \"54\"\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\": \"2\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\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\": \"2\",\n \"service_id\": \"72\",\n \"servicecategory_id\": \"53\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"10.100000\",\n \"total_quantity\": \"10.100000\",\n \"unit_based_subtotal_charge\": \"14.81\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"14.81\",\n \"total_charge\": \"14.81\",\n \"total_cogs\": \"112.21\",\n \"total_net\": \"-97.40\",\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\": \"2\",\n \"service_id\": \"75\",\n \"servicecategory_id\": \"55\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"13.000000\",\n \"total_quantity\": \"13.000000\",\n \"unit_based_subtotal_charge\": \"32.50\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"32.50\",\n \"total_charge\": \"32.50\",\n \"total_cogs\": \"28.60\",\n \"total_net\": \"3.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\": \"20170826\",\n \"account_id\": \"1\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\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\": \"1\",\n \"service_id\": \"73\",\n \"servicecategory_id\": \"54\"\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\": \"1\",\n \"service_id\": \"74\",\n \"servicecategory_id\": \"54\"\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\": \"2\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\n },\n {\n \"rate_id\": null,\n \"subtotal_quantity\": \"24.000000\",\n \"total_quantity\": \"24.000000\",\n \"unit_based_subtotal_charge\": \"60.00\",\n \"interval_based_subtotal_charge\": \"0.00\",\n \"subtotal_charge\": \"60.00\",\n \"total_charge\": \"60.00\",\n \"total_cogs\": \"52.80\",\n \"total_net\": \"7.20\",\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\": \"1\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\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\": \"1\",\n \"service_id\": \"73\",\n \"servicecategory_id\": \"54\"\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\": \"1\",\n \"service_id\": \"74\",\n \"servicecategory_id\": \"54\"\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\": \"2\",\n \"service_id\": \"71\",\n \"servicecategory_id\": \"53\"\n }\n ]\n}"},{"id":"08103d30-423b-45d3-9b6b-ef14484dc608","name":"Run a report - format CSV","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{base_url}}/v1/reports/:report_id/run?start={{start}}&end={{end}}&format=csv","host":["{{base_url}}"],"path":["v1","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.","disabled":true},{"key":"timeline","value":"","description":"One of `day`, `month` or `none`. Defaults to `day`.","disabled":true},{"key":"depth","value":"","description":"The depth in the report definition you want to report on. Defaults to 1.","disabled":true},{"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.","disabled":true},{"key":"filter[attribute]","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.","disabled":true},{"key":"format","value":"csv","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`.","disabled":true},{"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`.","disabled":true},{"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.","disabled":true},{"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.","disabled":true},{"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`.","disabled":true}],"variable":[{"key":"report_id","value":"{{report_id}}","description":"ID of report to run"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 Oct 2023 08:33:03 GMT"},{"key":"Date","value":"Mon, 09 Oct 2023 08:33:03 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"text/csv; charset=UTF-8"},{"key":"X-Proximity-Cache","value":"miss"},{"key":"Content-Disposition","value":"attachment; filename=\"report-test_depth-reseller_range-20170101-20231231.csv\""},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Clockwork-Id","value":"X9ed54c08e6df6fb34aa3fe25e4a2f8c6"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X9ed54c08e6df6fb34aa3fe25e4a2f8c6"},{"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-xBv56oZ62TI3FLqSdg4xOXyVs7gpRNOy';style-src 'self' 'nonce-xBv56oZ62TI3FLqSdg4xOXyVs7gpRNOy';font-src 'self' data:"},{"key":"Request-Id","value":"d28616c7-3d13-4588-bf06-921b77107d7a"}],"cookie":[],"responseTime":null,"body":"rate_id,subtotal_quantity,total_quantity,unit_based_subtotal_charge,interval_based_subtotal_charge,subtotal_charge,total_charge,total_cogs,total_net,min_commit_delta_quantity,min_commit_delta_charge,adjustments,tier_breakdown,avg_unit_based_rate,avg_interval_based_rate,breakdown,day,account_id,service_id,servicecategory_id\n,13.000000,13.000000,32.50,0.00,32.50,32.50,28.60,3.90,0.000000,0.00,,,2.50000000,0.00000000,,20170825,1,71,53\n,6.000000,6.000000,7.20,0.00,7.20,7.20,4.80,2.40,0.000000,0.00,,,1.20000000,0.00000000,,20170825,1,72,53\n,116.000000,116.000000,1985.04,0.00,1985.04,1985.04,1600.80,384.24,0.000000,0.00,,,17.11240000,0.00000000,,20170825,1,73,54\n,120.000000,120.000000,240.04,0.00,240.04,240.04,120.02,120.01,0.000000,0.00,,,2.00030000,0.00000000,,20170825,1,74,54\n,3.111100,3.111100,7.78,0.00,7.78,7.78,6.84,0.93,0.000000,0.00,,,2.50000000,0.00000000,,20170825,2,71,53\n,1.999900,1.999900,2.40,0.00,2.40,2.40,1.60,0.80,0.000000,0.00,,,1.20000000,0.00000000,,20170825,2,72,53\n,10.100000,10.100000,14.81,0.00,14.81,14.81,112.21,-97.40,0.000000,0.00,,,1.46612903,0.00000000,,20170825,2,75,55\n,13.000000,13.000000,32.50,0.00,32.50,32.50,28.60,3.90,0.000000,0.00,,,2.50000000,0.00000000,,20170826,1,71,53\n,116.000000,116.000000,1996.77,0.00,1996.77,1996.77,1612.43,384.33,0.000000,0.00,,,17.21350000,0.00000000,,20170826,1,73,54\n,119.798000,119.798000,239.63,0.00,239.63,239.63,119.82,119.81,0.000000,0.00,,,2.00030000,0.00000000,,20170826,1,74,54\n,3.111100,3.111100,7.78,0.00,7.78,7.78,6.84,0.93,0.000000,0.00,,,2.50000000,0.00000000,,20170826,2,71,53\n,24.000000,24.000000,60.00,0.00,60.00,60.00,52.80,7.20,0.000000,0.00,,,2.50000000,0.00000000,,20170827,1,71,53\n,116.000000,116.000000,1985.04,0.00,1985.04,1985.04,1600.80,384.24,0.000000,0.00,,,17.11240000,0.00000000,,20170827,1,73,54\n,120.000000,120.000000,240.04,0.00,240.04,240.04,120.02,120.01,0.000000,0.00,,,2.00030000,0.00000000,,20170827,1,74,54\n,5.111100,5.111100,12.78,0.00,12.78,12.78,11.24,1.53,0.000000,0.00,,,2.50000000,0.00000000,,20170827,2,71,53\n"}],"_postman_id":"91ce1789-2708-8c84-84f6-4691b9bbd408"},{"name":"Fetch report resources","event":[{"listen":"test","script":{"id":"3ec9c5d8-deb1-43ea-8ea2-d19782fd1390","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"}}],"id":"7427e8bf-44ed-47f0-bf48-f1813ce5c905","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}}/v1/reports/:report_id/resources?start={{start}}&end={{end}}&dimension=&depth=&filter[attribute]","description":"⚠️ This endpoint is currently in alpha and may change at any time. Please don't use in production.
\n","urlObject":{"path":["v1","reports",":report_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 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.
Report to fetch resources on
\n","type":"text/plain"},"type":"string","value":"{{report_id}}","key":"report_id"}]}},"response":[{"id":"957c4efc-47be-4be1-b7ae-2bb63ea97ef4","name":"Fetch report resources","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v1/reports/:report_id/resources?start={{start}}&end={{end}}&dimension=&depth=&filter[attribute]","host":["{{base_url}}"],"path":["v1","reports",":report_id","resources"],"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`."},{"key":"depth","value":"","description":"The depth in the report definition you want to report on. Defaults to 1."},{"key":"filter[attribute]","value":null,"description":"Optionally [filter](#working-with-the-api) 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."}],"variable":[{"key":"report_id","value":"{{report_id}}","type":"string","description":"Report to fetch resources on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 Oct 2023 08:31:51 GMT"},{"key":"Date","value":"Mon, 09 Oct 2023 08:31:51 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":"Xabb4d507d53c1e97b3dc3916a7d269de"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xabb4d507d53c1e97b3dc3916a7d269de"},{"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-IORts05ldYH603cbiJCTikss9hK7rq5C';style-src 'self' 'nonce-IORts05ldYH603cbiJCTikss9hK7rq5C';font-src 'self' data:"},{"key":"Request-Id","value":"2da0e8e7-9a52-4f6b-87a1-253f22ea0223"}],"cookie":[],"responseTime":null,"body":"{\n \"resources\": {\n \"account_ids\": [\n \"1\",\n \"2\"\n ],\n \"service_ids\": [\n \"71\",\n \"72\",\n \"73\",\n \"74\",\n \"75\"\n ],\n \"servicecategory_ids\": [\n \"53\",\n \"54\",\n \"55\"\n ]\n }\n}"}],"_postman_id":"7427e8bf-44ed-47f0-bf48-f1813ce5c905"},{"name":"Delete a report definition","event":[{"listen":"test","script":{"id":"726795e6-603a-4c76-b26e-daa9b1104425","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET report_id');","pm.environment.unset(\"report_id\");"],"type":"text/javascript"}}],"id":"361ac871-7a68-e539-eb1c-8b3bf1eeaa3e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":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}}/v1/reports/:report_id","description":"On success, a HTTP 204 No Content success status response will be returned.
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
\nIf a report has data, it will be contained inside data_status objects.
\nLimit 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},{"description":{"content":"Include additional related resources. Possible values: services, adjustments, budgetitems.
Include additional related resources. Possible values: services, adjustments, budgetitems.
On success, a HTTP 204 No Content success status response will be returned.
Categories 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 resources can be included:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5c63ff40-2109-4a78-ae78-ac7b456f4d3e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ba3c502-d4f8-4997-b663-d2ac772d4777","type":"text/javascript","exec":[""]}}],"_postman_id":"7220b5bd-06ad-5ebb-2d4e-2d60833f283a"},{"name":"/services","item":[{"name":"Retrieve a list of services","event":[{"listen":"test","script":{"id":"b6d898f6-a5c3-44d2-a63f-8e6dcf40f387","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":"5184324e-8829-4ffc-b8c2-8386ced1613b","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":"c78ac4f1-c9f3-ac01-c4b5-4247e5e7fc8f","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}}/v1/services?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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},{"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},{"description":{"content":"Include additional related resources. Possible values: servicecategory, rates, adjustments, dset, metadata, budgetitems.
Include additional related resources. Possible values: servicecategory, rates, adjustments, dset, metadata, budgetitems.
Service ID
\n","type":"text/plain"},"type":"string","value":"{{service_id}}","key":"service_id"}]}},"response":[{"id":"b5229a09-a961-4405-b8cc-5dcdac667b5c","name":"Prepare affected reports","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{base_url}}/v1/services/:service_id/prepareAffectedReports","host":["{{base_url}}"],"path":["v1","services",":service_id","prepareAffectedReports"],"variable":[{"key":"service_id","value":"{{service_id}}","type":"string","description":"Service ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 01 Feb 2022 11:31:17 GMT"},{"key":"Date","value":"Tue, 01 Feb 2022 11:31:17 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":"Xfdbfd6fd395249d630cdc71f64eb3bf2"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xfdbfd6fd395249d630cdc71f64eb3bf2"},{"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-c5q44AsGHpwV6Bc2iUYKWAgM9woY1KvG';style-src 'self' 'nonce-c5q44AsGHpwV6Bc2iUYKWAgM9woY1KvG';font-src 'self' data:"},{"key":"Request-Id","value":"73d14dae-0ace-4752-9bc5-50e413acb188"}],"cookie":[],"responseTime":null,"body":"{\n \"prepare_report\": [\n {\n \"info\": {\n \"report_name\": \"test\",\n \"range\": \"all\"\n },\n \"data\": [\n {\n \"report_id\": 1,\n \"dset\": \"test.usage\",\n \"first_date\": \"20170825\",\n \"last_date\": \"20170827\",\n \"status\": [\n {\n \"date\": \"20170825\",\n \"result\": \"skipped\",\n \"records\": 0\n },\n {\n \"date\": \"20170826\",\n \"result\": \"skipped\",\n \"records\": 0\n },\n {\n \"date\": \"20170827\",\n \"result\": \"skipped\",\n \"records\": 0\n }\n ]\n }\n ]\n },\n {\n \"info\": {\n \"report_name\": \"Test report - 976\",\n \"range\": \"all\"\n },\n \"data\": [\n {\n \"report_id\": 2,\n \"dset\": \"test.usage\",\n \"first_date\": \"20170825\",\n \"last_date\": \"20170827\",\n \"status\": [\n {\n \"date\": \"20170825\",\n \"result\": \"ok\",\n \"records\": 20\n },\n {\n \"date\": \"20170826\",\n \"result\": \"ok\",\n \"records\": 20\n },\n {\n \"date\": \"20170827\",\n \"result\": \"ok\",\n \"records\": 20\n }\n ]\n }\n ]\n },\n {\n \"info\": {\n \"report_name\": \"Test report - 25\",\n \"range\": \"all\"\n },\n \"data\": [\n {\n \"report_id\": 3,\n \"dset\": \"test.usage\",\n \"first_date\": \"20170825\",\n \"last_date\": \"20170827\",\n \"status\": [\n {\n \"date\": \"20170825\",\n \"result\": \"ok\",\n \"records\": 20\n },\n {\n \"date\": \"20170826\",\n \"result\": \"ok\",\n \"records\": 20\n },\n {\n \"date\": \"20170827\",\n \"result\": \"ok\",\n \"records\": 20\n }\n ]\n }\n ]\n }\n ],\n \"report\": [\n {\n \"info\": {\n \"report_name\": \"test\",\n \"start_date\": \"20170825\",\n \"end_date\": \"20170827\",\n \"days_in_range\": 4,\n \"days_missing\": 0,\n \"days_unprepared\": 0,\n \"days_with_errors\": 0,\n \"output_table\": \"pgp_1\",\n \"instance_output_count\": 40,\n \"service_output_count\": 40,\n \"total_output_count\": 80,\n \"result\": \"success\"\n }\n },\n {\n \"info\": {\n \"report_name\": \"Test report - 976\",\n \"start_date\": \"20170825\",\n \"end_date\": \"20170827\",\n \"days_in_range\": 4,\n \"days_missing\": 0,\n \"days_unprepared\": 0,\n \"days_with_errors\": 0,\n \"output_table\": \"pgp_2\",\n \"instance_output_count\": 40,\n \"service_output_count\": 11,\n \"total_output_count\": 51,\n \"result\": \"success\"\n }\n },\n {\n \"info\": {\n \"report_name\": \"Test report - 25\",\n \"start_date\": \"20170825\",\n \"end_date\": \"20170827\",\n \"days_in_range\": 4,\n \"days_missing\": 0,\n \"days_unprepared\": 0,\n \"days_with_errors\": 0,\n \"output_table\": \"pgp_3\",\n \"instance_output_count\": 40,\n \"service_output_count\": 11,\n \"total_output_count\": 51,\n \"result\": \"success\"\n }\n }\n ]\n}"}],"_postman_id":"036e8d8f-585c-41d0-9c1d-5e74fe34a3bd"},{"name":"Delete a service","event":[{"listen":"test","script":{"id":"a9b33957-8d7c-45d2-a6c7-19a5150adb1b","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET service_id');","pm.environment.unset(\"service_id\");","","pm.environment.unset(\"service_key\");","console.log('UNSET service_key');"],"type":"text/javascript"}}],"id":"a4bcd022-a6df-4ae6-9bf3-06f0bedde601","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":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}}/v1/services/:service_id","description":"On success, a HTTP 204 No Content success status response will be returned.
Services 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 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":"Optionally 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.
On success, a HTTP 204 No Content success status response will be returned.
Subscriptions enable users to manage one-off and recurring transactions for charging non-metered services.
\nExivity documentation: https://docs.exivity.com/services/subscriptions
\n⚠️ Available since v3.0.0
\nLimit 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},{"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
Rate ID
\n","type":"text/plain"},"type":"any","value":"{{rate_id}}","key":"rate_id"}]}},"response":[{"id":"ed5a1261-7f7c-4228-baa4-c2dfac624527","name":"Retrieve a rate","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v1/rates/:rate_id?include=","host":["{{base_url}}"],"path":["v1","rates",":rate_id"],"query":[{"key":"include","value":"","description":"Include additional related resources. Possible values: `service`, `account`, `ratetiers`"}],"variable":[{"id":"47513a26-895e-4a2f-acfd-985b8b1f7625","key":"rate_id","value":"{{rate_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 01 Feb 2022 12:44:47 GMT"},{"key":"Date","value":"Tue, 01 Feb 2022 12:44:47 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":"X8731b074e90a76fd8a316927e7d54002"},{"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-ufbIP398ZLvcQFljjaEBOh6J8KvnnPKP';style-src 'self' 'nonce-ufbIP398ZLvcQFljjaEBOh6J8KvnnPKP';font-src 'self' data:"},{"key":"Request-Id","value":"ec14108f-8f81-4c69-ad27-10d62027584c"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"rate\",\n \"id\": \"8\",\n \"attributes\": {\n \"rate\": 1,\n \"rate_col\": \"rate_col\",\n \"min_commit\": 0,\n \"effective_date\": \"2017-09-27\",\n \"tier_aggregation_level\": 1,\n \"fixed\": 2,\n \"fixed_col\": \"fixed_col\",\n \"cogs_rate\": 3,\n \"cogs_rate_col\": \"cogs_rate_col\",\n \"cogs_fixed\": 4,\n \"cogs_fixed_col\": \"cogs_fixed_col\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/rates/8\"\n },\n \"relationships\": {\n \"service\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/rates/8/relationships/service\",\n \"related\": \"http://localhost:8012/v1/rates/8/service\"\n }\n },\n \"account\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/rates/8/relationships/account\",\n \"related\": \"http://localhost:8012/v1/rates/8/account\"\n }\n },\n \"ratetiers\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/rates/8/relationships/ratetiers\",\n \"related\": \"http://localhost:8012/v1/rates/8/ratetiers\"\n }\n }\n }\n }\n}"}],"_postman_id":"44a13da5-4b44-b03b-2458-39fb9768e189"},{"name":"Prepare affected reports","event":[{"listen":"test","script":{"id":"3c408348-5cd7-4c23-bba7-79fa89ee7d36","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","console.log(pm.response);"],"type":"text/javascript"}}],"id":"7f667470-caf0-b7bc-cdaf-46d7b7cdc345","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}}/v1/rates/:rate_id/prepareAffectedReports","urlObject":{"path":["v1","rates",":rate_id","prepareAffectedReports"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{rate_id}}","key":"rate_id"}]}},"response":[],"_postman_id":"7f667470-caf0-b7bc-cdaf-46d7b7cdc345"},{"name":"Update a rate","event":[{"listen":"test","script":{"id":"16945c13-6e38-4f0b-b114-26105d49a4ab","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('rate');"," 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({"," \"rate\": 10,"," \"rate_col\": \"rate_col2\","," \"fixed\": 20,"," \"fixed_col\": \"fixed_col2\","," \"cogs_rate\": 30,"," \"cogs_rate_col\": \"cogs_rate_col2\","," \"cogs_fixed\": 40,"," \"cogs_fixed_col\": \"cogs_fixed_col2\","," \"effective_date\": \"2017-08-28\","," \"min_commit\": 50,"," });","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"cf53c428-7015-4f22-6784-88c592b13b36","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\": \"rate\",\r\n \"id\": \"{{rate_id}}\",\r\n \"attributes\": {\r\n \"min_commit\": 50,\r\n \"rate\": \"10.0\",\r\n \"rate_col\": \"rate_col2\",\r\n \"fixed\": \"20.0\",\r\n \"fixed_col\": \"fixed_col2\",\r\n \"cogs_rate\": \"30.0\",\r\n \"cogs_rate_col\": \"cogs_rate_col2\",\r\n \"cogs_fixed\": \"40.0\",\r\n \"cogs_fixed_col\": \"cogs_fixed_col2\"\r\n \r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/rates/:rate_id","urlObject":{"path":["v1","rates",":rate_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{rate_id}}","key":"rate_id"}]}},"response":[],"_postman_id":"cf53c428-7015-4f22-6784-88c592b13b36"},{"name":"Delete a rate","event":[{"listen":"test","script":{"id":"8394c1a9-b96c-4716-af0d-37271ea40f4c","exec":["/*pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET rate_id');","pm.environment.unset(\"rate_id\");*/"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1589fa07-25f2-44bd-9533-95f973be7451","exec":[""],"type":"text/javascript"}}],"id":"8e869ba6-9971-6bdd-60a2-e4c60046b5d4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":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}}/v1/rates/:rate_id","description":"On success, a HTTP 204 No Content success status response will be returned.
Rates allows you to configure manual rates for services that do not have a rate provided with their data source.
\nExivity documentation: https://docs.exivity.com/services/rates
\nLimit 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},{"description":{"content":"Include additional related resources. Possible values: rate.
Include additional related resources. Possible values: rate.
⚠️ These endpoints are currently in alpha and may change at any time. Please don't use in production.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"0122b6eb-de76-4635-be7b-e4c86a68df6f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77ab14d2-fd4f-457d-8310-4a76335dc349","type":"text/javascript","exec":[""]}}],"_postman_id":"88f61d49-36e5-458f-9a2c-523658ab4631"},{"name":"/adjustments","item":[{"name":"Retrieve a list of adjustments","event":[{"listen":"test","script":{"id":"39c91cc0-a05b-44d6-a045-547af2160b1c","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":"2dd6d417-9b01-51b4-0054-8706070923ea","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}}/v1/adjustments?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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":[{"type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[],"_postman_id":"26772232-c39a-d760-f3aa-1ab8ac3aa793"},{"name":"Update an adjustment","event":[{"listen":"test","script":{"id":"c37dc956-0d32-4483-a6ba-2251968f9d9b","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":"79e2e2dd-366a-798d-d39d-e785ceef8fa1","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}}/v1/adjustments/:adjustment_id","urlObject":{"path":["v1","adjustments",":adjustment_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[],"_postman_id":"79e2e2dd-366a-798d-d39d-e785ceef8fa1"},{"name":"Prepare affected reports","event":[{"listen":"test","script":{"id":"3c408348-5cd7-4c23-bba7-79fa89ee7d36","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","console.log(pm.response);"],"type":"text/javascript"}}],"id":"6429099a-dd77-4dd7-88d1-8e31e59c4477","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}}/v1/adjustments/:adjustment_id/prepareAffectedReports","urlObject":{"path":["v1","adjustments",":adjustment_id","prepareAffectedReports"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"{{adjustment_id}}","key":"adjustment_id"}]}},"response":[],"_postman_id":"6429099a-dd77-4dd7-88d1-8e31e59c4477"},{"name":"Delete an adjustment","event":[{"listen":"test","script":{"id":"d039b6ae-a001-46e8-98d9-91d53c11181d","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":"af8e10f8-dfa7-cfe7-3766-69d75eefa9b7","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept-encoding":true,"accept":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}}/v1/adjustments/:adjustment_id","description":"On success, a HTTP 204 No Content success status response will be returned.
Adjustments 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b9bdf7ba-0cd2-495b-b74d-e8250725ff00","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"621bced5-9556-4c1d-85e6-d3ee2eb53622","type":"text/javascript","exec":[""]}}],"_postman_id":"4dfd68e7-c992-32af-d8c6-e03a41c940ca"}],"id":"71932c96-2982-4373-9c17-10d23a9d292c","description":"Categories 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
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":""},{"description":{"content":"Include additional related resources. Possible values: report, parent, children, rates, adjustments, users, metadata, budgetitems, servicesubscriptions.
Include additional related resources. Possible values: report, parent, children, rates, adjustments, users.
On success, a HTTP 204 No Content success status response will be returned.
Exivity documentation: https://docs.exivity.com/reports/accounts
\nLimit 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},{"description":{"content":"Include additional related resources. Possible values: revisions, report.
Include additional related resources: revisions
On success, a HTTP 204 No Content success status response will be returned.
Exivity documentation: https://docs.exivity.com/reports/budget
\nOptionally filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: budget, items
Include additional related resources. Possible values: budget, items
On success, a HTTP 204 No Content success status response will be returned.
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},{"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
On success, a HTTP 204 No Content success status response will be returned.
Environment ID (optional)
\n","type":"text/plain"},"key":"environment_id","value":""}],"variable":[]}},"response":[{"id":"5a45f400-4cdc-43c0-ae4e-ff855fa892c5","name":"Run an extractor","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"job\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"type\": \"extract\",\r\n \"id\": \"{{extractor_name}}\"\r\n\t\t}\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/extractors/{{extractor_name}}/run","host":["{{base_url}}"],"path":["v1","extractors","{{extractor_name}}","run"],"query":[{"key":"environment_id","value":"","description":"Environment ID (optional)","disabled":true}]}},"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:15:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X9ac67c880a7d87c4d4c9bc1f50ce8015"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X9ac67c880a7d87c4d4c9bc1f50ce8015"},{"key":"ETag","value":"\"d7bf710e3ae4342ebead0b0b862b9bb3\""},{"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-CcSBQq7IAJUXKlzRqpBJhSLTl1aw0waU';style-src 'self' 'nonce-CcSBQq7IAJUXKlzRqpBJhSLTl1aw0waU';font-src 'self' data:"},{"key":"Request-Id","value":"ffddcce6-6c84-451b-8a19-ec00f5bfa091"}],"cookie":[],"responseTime":null,"body":"[\n \"=================================\\r\\nUSE: Unified Scriptable Extractor\\r\\n=================================\\r\\nHello world \\r\\n\\r\\nUSE script finished successfully\\r\\n\"\n]"}],"_postman_id":"4e59415c-aabc-23c7-9e88-446a18061e36"},{"name":"Delete an extractor","event":[{"listen":"test","script":{"id":"6feb0ad2-ea8e-41c8-8d7f-9c018e0d0dc3","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":"57a69d9c-ce34-4152-fb87-65fe92bcae02","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}}/v1/extractors/{{extractor_name}}","description":"On success, a HTTP 204 No Content success status response will be returned.
Extraction is the process by which USE (Unified Scriptable Extractor) retrieves data from external locations. Read more.
\nDate 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":"string","value":"{{transformer_name}}","key":"transformer_name"}]}},"response":[],"_postman_id":"96719165-6a30-500d-6b2d-8421ddf4460f"},{"name":"Delete a transformer","event":[{"listen":"test","script":{"id":"15edb4af-82c9-4a2a-a3e9-f3ffcfd842df","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":"87fe7c9b-8096-d170-e96c-4f97570f0002","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}}/v1/transformers/{{transformer_name}}","urlObject":{"path":["v1","transformers","{{transformer_name}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9f33e986-8602-4048-ac3b-f1ad1e0e2aaf","name":"Delete a transformer","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/v1/transformers/{{transformer_name}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 09:38:03 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 09:38:03 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Clockwork-Id","value":"X0deb90e36eed194b117bdd583b7e16d1"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X0deb90e36eed194b117bdd583b7e16d1"},{"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-PxhO5QqkqpupROWRKpVh2W9udAUiaxnF';style-src 'self' 'nonce-PxhO5QqkqpupROWRKpVh2W9udAUiaxnF';font-src 'self' data:"},{"key":"Request-Id","value":"d55ebbc5-d9cf-4400-b23e-32a24f7a248d"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"87fe7c9b-8096-d170-e96c-4f97570f0002"}],"id":"e240c0ea-6e41-612f-3f90-e597022013ca","description":"Exivity documentation: https://docs.exivity.com/data-pipelines/transform
\nLimit 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},{"description":{"content":"Include additional related resources. Possible values: services, reports, metadatadefinition.
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":"string","value":"{{dset_id}}","key":"name"}]}},"response":[],"_postman_id":"4d4f2e89-e499-46ce-afca-ec88b7692b8b"}],"id":"6f25717a-cc68-0898-4ab6-f1b70f89380b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"aa653abe-06ac-435b-bfd8-5a2b813821d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"55a0217d-0a48-4e26-bcb5-5a1099aad48e","type":"text/javascript","exec":[""]}}],"_postman_id":"6f25717a-cc68-0898-4ab6-f1b70f89380b","description":""},{"name":"/file","item":[{"name":"Upload a file","event":[{"listen":"test","script":{"id":"b781198a-08aa-44a6-8421-e2ffe7e2b12d","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":"837072b6-3248-514b-bf2f-3e9d668198ae","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":"file","value":null},{"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}}/v1/file","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.
Folder path
\n","type":"text/plain"},"type":"string","value":"","key":"folder"}]}},"response":[{"id":"04a13e9c-47ee-4d2c-8378-2c900725286e","name":"List files in specific folder","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v1/file/generic/2023/06"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 01 Jun 2023 10:28:22 GMT"},{"key":"Date","value":"Thu, 01 Jun 2023 10:28:21 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.6"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xa27a8d61715227559d70d17795dd716e"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xa27a8d61715227559d70d17795dd716e"},{"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-dLpwQNl8MwCnAHrwG3Y9sNoVgVn3FWxK';style-src 'self' 'nonce-dLpwQNl8MwCnAHrwG3Y9sNoVgVn3FWxK';font-src 'self' data:"},{"key":"Request-Id","value":"c26fc692-8bb4-490d-a8ea-06d3f3f7a44d"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"file\",\n \"name\": \"01_uploaded_001.txt\",\n \"path\": \"/generic/2023/06\"\n }\n ]\n}"},{"id":"c322899a-0fde-4472-b33c-eededf712dc2","name":"List files in root folder","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v1/file/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 01 Jun 2023 10:29:42 GMT"},{"key":"Date","value":"Thu, 01 Jun 2023 10:29:42 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.6"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X62560889c14934e994108c9e4fa60da5"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X62560889c14934e994108c9e4fa60da5"},{"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-Nv5CKCaXRiJedbcxhxXU7pMEJf4irnwT';style-src 'self' 'nonce-Nv5CKCaXRiJedbcxhxXU7pMEJf4irnwT';font-src 'self' data:"},{"key":"Request-Id","value":"a99f8069-f6bb-4d51-8da8-20358e12c9c6"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"folder\",\n \"name\": \"generic\",\n \"path\": \"/\",\n \"children\": [\n {\n \"type\": \"folder\",\n \"name\": \"2023\",\n \"path\": \"/generic\",\n \"children\": [\n {\n \"type\": \"folder\",\n \"name\": \"06\",\n \"path\": \"/generic/2023\",\n \"children\": [\n {\n \"type\": \"file\",\n \"name\": \"01_uploaded_001.txt\",\n \"path\": \"/generic/2023/06\"\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"type\": \"folder\",\n \"name\": \"temp\",\n \"path\": \"/\",\n \"children\": [\n {\n \"type\": \"folder\",\n \"name\": \"2023\",\n \"path\": \"/temp\",\n \"children\": [\n {\n \"type\": \"folder\",\n \"name\": \"06\",\n \"path\": \"/temp/2023\",\n \"children\": [\n {\n \"type\": \"file\",\n \"name\": \"01_uploaded_001.txt\",\n \"path\": \"/temp/2023/06\"\n },\n {\n \"type\": \"file\",\n \"name\": \"01_uploaded_002.txt\",\n \"path\": \"/temp/2023/06\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"3e829aa7-388a-4913-8b68-41e7b73c6433"},{"name":"Retrieve file","event":[{"listen":"test","script":{"id":"b781198a-08aa-44a6-8421-e2ffe7e2b12d","exec":["// Only test Unprocessable Entity for now, as we're not actually uploading a file","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('array');","// });"],"type":"text/javascript"}}],"id":"7aba0a55-55ff-4593-885e-a9880b586d4d","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}}/v1/file/:folder/:filename","urlObject":{"path":["v1","file",":folder",":filename"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"folder"},{"type":"string","value":"","key":"filename"}]}},"response":[],"_postman_id":"7aba0a55-55ff-4593-885e-a9880b586d4d"},{"name":"Delete a file","event":[{"listen":"test","script":{"id":"b781198a-08aa-44a6-8421-e2ffe7e2b12d","exec":["// Since we can't upload a file, it's a bit hard to delete it","// This test tried to delete a non-existant file. We expect a error back.","pm.test(\"Status code is 404\", function () {"," pm.response.to.have.status(404);","});","","const response = pm.response.json();","console.log(response);","","pm.test(\"Response contains error\", function () {"," pm.expect(response.errors).to.be.an('array');","});","","pm.test(\"Error has title and detail\", function () {"," pm.expect(response.errors[0].title).to.be.eql('NotFoundException');"," pm.expect(response.errors[0].detail).to.be.eql('File name missing');","});",""],"type":"text/javascript"}}],"id":"400853c4-f528-458b-bc7e-f5a5cb264587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v1/file/:folder/:filename","urlObject":{"path":["v1","file",":folder",":filename"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"","key":"folder"},{"type":"string","value":"","key":"filename"}]}},"response":[],"_postman_id":"400853c4-f528-458b-bc7e-f5a5cb264587"}],"id":"7d48bdde-6981-8dd1-7e2f-510d938ad22f","description":"⚡ Not JSON:API compliant ⚡
\nAtomic support: ❌
\nThis endpoint lets you work with files in the Exivity home directory. Currently, only uploading files is supported.
\nNote: starting with Exivity v3.0.0, the response structure for all endpoints will be streamlined.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"64c27581-239e-446d-8222-6aa46589f038","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e60aa72b-d37a-479d-a7c4-9a5d5b4e4f9a","type":"text/javascript","exec":[""]}}],"_postman_id":"7d48bdde-6981-8dd1-7e2f-510d938ad22f"},{"name":"/metadatadefinitions","item":[{"name":"Retrieve a list of metadata definitions","event":[{"listen":"test","script":{"id":"0fe73c41-f52e-40fe-b9ca-b44fa9df95f3","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":"800e131a-b629-42bf-a81c-1012edfc613a","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}}/v1/metadatadefinitions?page[limit]&page[offset]&sort&filter[name]=&include=","urlObject":{"path":["v1","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":"Optionally 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.
\n","type":"text/plain"},"key":"include","value":null}],"variable":[]}},"response":[{"id":"31590325-8854-4bc0-b8d3-05b02a1cc336","name":"Retrieve a metadata definition","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v1/metadatadefinitions/{{metadatadefinition_id}}/?include","host":["{{base_url}}"],"path":["v1","metadatadefinitions","{{metadatadefinition_id}}",""],"query":[{"key":"include","value":null,"description":"Include additional related resources."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 09:40:42 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 09:40:42 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":"Xdc8a5a604634bc6ca3f98917f5b7e5d6"},{"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-HX1KoKuxsFcwIrwNsTNLcNTDn9hXxdWT';style-src 'self' 'nonce-HX1KoKuxsFcwIrwNsTNLcNTDn9hXxdWT';font-src 'self' data:"},{"key":"Request-Id","value":"20d378f7-ff64-4908-8b35-5cb38deba070"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"metadatadefinition\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Test definition\",\n \"fields\": [\n {\n \"name\": \"country\",\n \"type\": \"string\"\n }\n ]\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/1\"\n },\n \"relationships\": {\n \"metadata\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/1/relationships/metadata\",\n \"related\": \"http://localhost:8012/v1/metadatadefinitions/1/metadata\"\n }\n },\n \"datasets\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/1/relationships/datasets\",\n \"related\": \"http://localhost:8012/v1/metadatadefinitions/1/datasets\"\n }\n }\n }\n }\n}"}],"_postman_id":"9da3b238-8a0d-4b2f-a042-29548e2ebcb0"},{"name":"Update a metadata definition","event":[{"listen":"test","script":{"id":"dd186fa1-8b31-4812-bb64-c6d81137dbb0","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('metadatadefinition');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"metadatadefinition_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.have.keys([","\t\t\"name\","," \"fields\"","\t]);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"97b59b2f-8e87-432e-b29c-d41eba7ccc27","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\t\"data\": {\r\n\t\t\"type\": \"metadatadefinition\",\r\n\t\t\"id\": \"{{metadatadefinition_id}}\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"Modified test definition - 776b552d-1157-4d55-b5ce-e7619fe6e9f4\",\r\n\t\t\t\"fields\": [\r\n\t\t\t\t{\r\n\t\t\t \"name\": \"country\",\r\n\t\t\t\t \"type\": \"string\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n \"name\": \"city\",\r\n\t\t\t\t \"type\": \"string\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/metadatadefinitions/:metadata_definition_id","urlObject":{"path":["v1","metadatadefinitions",":metadata_definition_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"string","value":"{{metadatadefinition_id}}","key":"metadata_definition_id"}]}},"response":[{"id":"cfaf2b52-2d0e-400c-90e2-a7db952da293","name":"Update a metadata definition","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\t\"data\": {\r\n\t\t\"type\": \"metadatadefinition\",\r\n\t\t\"id\": \"{{metadatadefinition_id}}\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"Modified test definition - 638920a9-2e39-41a5-b6f6-d237f6cd900c\",\r\n\t\t\t\"fields\": [\r\n\t\t\t\t{\r\n\t\t\t \"name\": \"country\",\r\n\t\t\t\t \"type\": \"string\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n \"name\": \"city\",\r\n\t\t\t\t \"type\": \"string\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t}\r\n}"},"url":{"raw":"{{base_url}}/v1/metadatadefinitions/:metadata_definition_id","host":["{{base_url}}"],"path":["v1","metadatadefinitions",":metadata_definition_id"],"variable":[{"key":"metadata_definition_id","value":"{{metadatadefinition_id}}","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 05 Sep 2023 11:39:51 GMT"},{"key":"Date","value":"Tue, 05 Sep 2023 11:39:51 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":"Xbec6399d6191b7c2c2b98ba3aa9e4628"},{"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-BsqM6lmC8Svr7UZJdWBVj9hTIesxBf30';style-src 'self' 'nonce-BsqM6lmC8Svr7UZJdWBVj9hTIesxBf30';font-src 'self' data:"},{"key":"Request-Id","value":"d0956825-9c46-4a0f-9bd3-b41321382212"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"metadatadefinition\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"Modified test definition - c9bb0f79-c9fb-41f5-8f5b-2d22b614063f\",\n \"fields\": [\n {\n \"name\": \"country\",\n \"type\": \"string\"\n },\n {\n \"name\": \"city\",\n \"type\": \"string\"\n }\n ]\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/2\"\n },\n \"relationships\": {\n \"metadata\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/2/relationships/metadata\",\n \"related\": \"http://localhost:8012/v1/metadatadefinitions/2/metadata\"\n }\n },\n \"datasets\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadatadefinitions/2/relationships/datasets\",\n \"related\": \"http://localhost:8012/v1/metadatadefinitions/2/datasets\"\n }\n }\n }\n }\n}"}],"_postman_id":"97b59b2f-8e87-432e-b29c-d41eba7ccc27"},{"name":"Delete a metadata definition","event":[{"listen":"test","script":{"id":"ae85860e-f9a6-48a6-8cf7-1b62c6e124b2","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET metadatadefinition_id');","pm.environment.unset(\"metadatadefinition_id\");"],"type":"text/javascript"}}],"id":"c90215de-b60d-473d-babd-f802be703ba1","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}}/v1/metadatadefinitions/{{metadatadefinition_id}}","description":"On success, a HTTP 204 No Content success status response will be returned.
Metadata 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":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[name]","value":""},{"description":{"content":"Include additional related resources. Possible values: definition, accounts, services.
Include additional related resources.
\n","type":"text/plain"},"key":"include","value":""}],"variable":[]}},"response":[{"id":"8935de25-50f1-4b69-9e18-c056ba0ae8f9","name":"Retrieve metadata","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v1/metadata/{{metadata_id}}/?include=","host":["{{base_url}}"],"path":["v1","metadata","{{metadata_id}}",""],"query":[{"key":"include","value":"","description":"Include additional related resources."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:14:50 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:14:50 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":"X66262b81b794a2c4746d392d58ba5d45"},{"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-NnLDJjSh3VHljBQuaGf1YQlI6lFlhJQP';style-src 'self' 'nonce-NnLDJjSh3VHljBQuaGf1YQlI6lFlhJQP';font-src 'self' data:"},{"key":"Request-Id","value":"c12eaef4-f368-43c5-9c8a-7dd29f6892f4"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"metadata\",\n \"id\": \"2\",\n \"attributes\": {\n \"values\": {\n \"country\": \"The Netherlands\"\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadata/2\"\n },\n \"relationships\": {\n \"accounts\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadata/2/relationships/accounts\",\n \"related\": \"http://localhost:8012/v1/metadata/2/accounts\"\n }\n },\n \"definition\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadata/2/relationships/definition\",\n \"related\": \"http://localhost:8012/v1/metadata/2/definition\"\n }\n },\n \"services\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/metadata/2/relationships/services\",\n \"related\": \"http://localhost:8012/v1/metadata/2/services\"\n }\n }\n }\n }\n}"}],"_postman_id":"9f872757-3764-4088-99dd-15a20493418f"},{"name":"Update metadata","event":[{"listen":"test","script":{"id":"dd186fa1-8b31-4812-bb64-c6d81137dbb0","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('metadata');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"metadata_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.have.keys([","\t\t\"values\"","\t]);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"91f68337-d759-40bc-9951-84ff231886b9","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\t\"data\": {\r\n\t\t\"type\": \"metadata\",\r\n\t\t\"id\": \"{{metadata_id}}\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"values\": {\r\n\t\t\t\t\"country\": \"The Netherlands\",\r\n\t\t\t\t\"city\": \"Zeist\"\r\n\t\t\t}\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/metadata/{{metadata_id}}","urlObject":{"path":["v1","metadata","{{metadata_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91f68337-d759-40bc-9951-84ff231886b9"},{"name":"Delete metadata","event":[{"listen":"test","script":{"id":"ae85860e-f9a6-48a6-8cf7-1b62c6e124b2","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET metadata_id');","pm.environment.unset(\"metadata_id\");","","// postman.setNextRequest(\"Delete a metadata definition\");"],"type":"text/javascript"}}],"id":"754ffb3f-a8b7-46b3-8d13-8c37a625f4a6","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}}/v1/metadata/{{metadata_id}}","description":"On success, a HTTP 204 No Content success status response will be returned.
Metadata 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"caf2ab7a-dd0d-4548-96e4-67dbfc493a83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c177daf4-85d6-4d3a-a699-4784c5a221ec","type":"text/javascript","exec":[""]}}],"_postman_id":"3ad3fac9-009b-4377-92d1-71d4b55ede7f"},{"name":"/workflows","item":[{"name":"Add a new workflow","event":[{"listen":"test","script":{"id":"525f1b0f-7dce-416f-86b1-3138a5f246ce","exec":["// Unset these variables as they will be attached to the old workflow","console.log('UNSET workflowrun_id');","pm.environment.unset(\"workflowrun_id\");","console.log('UNSET execute_workflowstep_id');","pm.environment.unset(\"execute_workflowstep_id\");","","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('workflow');"," 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({"," \"name\": \"test\","," \"description\": \"This is test task\""," });"," pm.expect(response.data.attributes.created_at).to.be.a('string');"," pm.expect(response.data.attributes.updated_at).to.be.a('string');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"workflow_id\", response.data.id);","console.log('SET workflow_id: ' + pm.environment.get(\"workflow_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"1927dddd-7cfe-490a-994a-d89c59c360e9","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":"faa34655-6b66-4a0e-bc67-a955709f9b59","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\": \"workflow\",\r\n \t\"attributes\": {\r\n \t\t\"name\": \"test\",\r\n \"description\": \"This is test task\"\r\n \t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/workflows","urlObject":{"path":["v1","workflows"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"45afad64-cef3-4acc-8c02-2a1eca598b61","name":"Add a new workflow","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\": \"workflow\",\r\n \t\"attributes\": {\r\n \t\t\"name\": \"test\",\r\n \"description\": \"This is test task\"\r\n \t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/workflows"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:17:15 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:17:15 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/v1/Workflow/Workflows"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xf0eb0fc1c1bb9b1038766023915ef353"},{"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-mcMqOAds8DaCyx3Qi2n8Q50WleEDOaC2';style-src 'self' 'nonce-mcMqOAds8DaCyx3Qi2n8Q50WleEDOaC2';font-src 'self' data:"},{"key":"Request-Id","value":"d045e665-1040-4955-80eb-8824e124763b"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflow\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"test\",\n \"description\": \"This is test task\",\n \"created_at\": \"2022-02-04T10:17:15Z\",\n \"updated_at\": \"2022-02-04T10:17:15Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflows/1\"\n },\n \"relationships\": {\n \"runs\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflows/1/relationships/runs\",\n \"related\": \"http://localhost:8012/v1/workflows/1/runs\"\n }\n },\n \"steps\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflows/1/relationships/steps\",\n \"related\": \"http://localhost:8012/v1/workflows/1/steps\"\n }\n },\n \"schedules\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflows/1/relationships/schedules\",\n \"related\": \"http://localhost:8012/v1/workflows/1/schedules\"\n }\n }\n }\n }\n}"}],"_postman_id":"faa34655-6b66-4a0e-bc67-a955709f9b59"},{"name":"Retrieve a list of workflows","event":[{"listen":"test","script":{"id":"43cdd595-34ac-4daf-b9fd-c752d610b552","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":"64b649b2-4521-44f2-979d-ef5063d6bec0","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}}/v1/workflows?page[limit]=&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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.
A workflow allows you to schedule various tasks and execute them at a specific date and time.
\nExivity documentation:
https://docs.exivity.com/Architecture%20concepts/Glossary#workflow
To create a workflow
\nCreate a workflow object
\nCreate a workflow schedule
\nAdd steps to the workflow
\nThe following relationships can be included:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"_postman_id":"6adb9863-cc52-4412-9977-5f2be41f3dcf"},{"name":"/workflowschedules","item":[{"name":"Add a new schedule","event":[{"listen":"test","script":{"id":"7cb87b26-e7f8-4b96-8ca5-4d7f9d0f5e81","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('workflowschedule');"," 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({"," \"start_time\": pm.environment.get(\"tomorrow\"),"," \"timezone\": \"Europe/Amsterdam\","," \"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');","});","","pm.environment.set(\"workflowschedule_id\", response.data.id);"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ac425683-0a12-4fd1-9fa7-39e5042b6c87","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.requireWorkflow)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r"," });\r","\r","var day = new Date(); // today\r","day.setDate(day.getDate() + 1); // tomorrow\r","pm.environment.set(\"tomorrow\", day.toISOString().slice(0, -5) + 'Z'); // Remove the milliseconds "],"type":"text/javascript"}}],"id":"154ce697-b1f1-4ee2-b898-c77cb3fc0750","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\": \"workflowschedule\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"start_time\": \"{{tomorrow}}\",\r\n\t\t\t\"timezone\": \"Europe/Amsterdam\",\r\n\t\t\t\"adjust_for_dst\": true,\r\n\t\t\t\"frequency\": \"daily\",\r\n\t\t\t\"frequency_modifier\": 2\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\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/workflowschedules","urlObject":{"path":["v1","workflowschedules"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"edaf9342-c425-4fd7-8e98-b9b8fac18a79","name":"Add a new schedule","originalRequest":{"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\": \"workflowschedule\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"start_time\": \"2020-01-01T18:00:00Z\",\r\n\t\t\t\"timezone\": \"Europe/Amsterdam\",\r\n\t\t\t\"adjust_for_dst\": true,\r\n\t\t\t\"frequency\": \"daily\",\r\n\t\t\t\"frequency_modifier\": 2\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\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/workflowschedules"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:19:40 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:19:40 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/v1/WorkflowSchedule/WorkflowSchedules"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X048f5350fd08da3544c5dcdac7de1a1b"},{"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-zUBusmtAXMAsCA7SWmHpbWUlmqW6XvRJ';style-src 'self' 'nonce-zUBusmtAXMAsCA7SWmHpbWUlmqW6XvRJ';font-src 'self' data:"},{"key":"Request-Id","value":"4fea186b-9645-4046-b044-31b6691c79c3"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowschedule\",\n \"id\": \"1\",\n \"attributes\": {\n \"start_time\": \"2020-01-01T18:00:00Z\",\n \"timezone\": \"Europe/Amsterdam\",\n \"adjust_for_dst\": true,\n \"frequency\": \"daily\",\n \"frequency_modifier\": 2,\n \"next_run\": \"1970-01-01T00:00:00Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1/relationships/workflow\",\n \"related\": \"http://localhost:8012/v1/workflowschedules/1/workflow\"\n }\n }\n }\n }\n}"}],"_postman_id":"154ce697-b1f1-4ee2-b898-c77cb3fc0750"},{"name":"Retrieve a list of schedules","event":[{"listen":"test","script":{"id":"5a5b54a8-535f-4c7a-b279-b1e5167d3013","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":"76f2c35b-05c9-41d3-9541-d0119c71c623","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}}/v1/workflowschedules?page[limit]&page[offset]&sort=&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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":[]}},"response":[{"id":"29e1de1d-179b-41a0-80ee-c39188c8c382","name":"Retrieve a schedule","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"{{base_url}}/v1/workflowschedules/{{workflowschedule_id}}?include=","host":["{{base_url}}"],"path":["v1","workflowschedules","{{workflowschedule_id}}"],"query":[{"key":"include","value":"","description":"Include additional related resources"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:20:11 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:20:11 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":"X8080573c708fcfb6e9767116beee1fee"},{"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-jB9Dj5jU9Ij1DUGA00aopqi1sOBerhPr';style-src 'self' 'nonce-jB9Dj5jU9Ij1DUGA00aopqi1sOBerhPr';font-src 'self' data:"},{"key":"Request-Id","value":"5ca9458d-a33a-4dac-aeba-d0895a034c1a"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowschedule\",\n \"id\": \"1\",\n \"attributes\": {\n \"start_time\": \"2020-01-01T18:00:00Z\",\n \"timezone\": \"Europe/Amsterdam\",\n \"adjust_for_dst\": true,\n \"frequency\": \"daily\",\n \"frequency_modifier\": 2,\n \"next_run\": \"2022-02-05T18:00:00Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1/relationships/workflow\",\n \"related\": \"http://localhost:8012/v1/workflowschedules/1/workflow\"\n }\n }\n }\n }\n}"}],"_postman_id":"1359f765-b49b-49df-8970-7b987db1e5f3"},{"name":"Update a schedule","event":[{"listen":"test","script":{"id":"f9701b1e-56dc-4ad5-8ddc-4202d0cc0af3","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\": pm.environment.get(\"tomorrow\"),"," \"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":"18ed8fdd-f4e9-485e-a606-8470b7ce0ebf","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}}/v1/workflowschedules/{{workflowschedule_id}}","urlObject":{"path":["v1","workflowschedules","{{workflowschedule_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1ca4dc98-4a54-4a54-9cc4-172c11a2b18e","name":"Update a schedule","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":"{{base_url}}/v1/workflowschedules/{{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.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 14 Jan 2025 10:55:35 GMT"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"Xb67a88098627032495b3f7baebc95d2f"},{"key":"X-Clockwork-Version","value":"9"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xb67a88098627032495b3f7baebc95d2f"},{"key":"ETag","value":"\"061ca906afd5b1c9d3e7d92ac764ad08\""},{"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-7HvtnymT5mJfQjaeKRwpQ581mApZJpEk';style-src 'self' 'nonce-7HvtnymT5mJfQjaeKRwpQ581mApZJpEk';font-src 'self' data:"},{"key":"Request-Id","value":"ef145156-9aed-45c9-b6fc-16578085fe3c"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"workflowschedule\",\n \"id\": \"1\",\n \"attributes\": {\n \"start_time\": \"2025-01-15T10:54:59Z\",\n \"timezone\": \"Europe/London\",\n \"adjust_for_dst\": true,\n \"frequency\": \"daily\",\n \"frequency_modifier\": 2,\n \"next_run\": \"2025-01-15T10:54:59Z\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1\"\n },\n \"relationships\": {\n \"workflow\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/workflowschedules/1/relationships/workflow\",\n \"related\": \"http://localhost:8012/v1/workflowschedules/1/workflow\"\n }\n }\n }\n }\n}"}],"_postman_id":"18ed8fdd-f4e9-485e-a606-8470b7ce0ebf"},{"name":"Delete a schedule","event":[{"listen":"test","script":{"id":"43015ed0-58cf-40ba-aa47-950a39d34893","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":"66d24aca-d359-412e-9e80-8cd4991b7293","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}}/v1/workflowschedules/{{workflowschedule_id}}","description":"On success, a HTTP 204 No Content success status response will be returned.
Exivity documentation:
https://docs.exivity.com/architecture%20concepts/glossary/#workflowschedule
Schedule how often a workflow should run.
\nThe following relationships can be included:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"92db3ac8-cdda-40c2-bfd2-51a20ab98901","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"165bde10-ad84-4cf5-a05c-96f680ee117e","type":"text/javascript","exec":[""]}}],"_postman_id":"7ac62937-0fe7-4780-8697-8a69fac8b820"},{"name":"/workflowsteps","item":[{"name":"Add a new extract(use) step","event":[{"listen":"test","script":{"id":"27e0be1c-a070-4db9-86ac-4b55394f9884","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","const response = pm.response.json();","console.log(pm.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\": \"use\",","\t\t\"timeout\": 600,"," });","","\tpm.expect(response.data.attributes.options).to.be.an('object');"," pm.expect(response.data.attributes.options).to.have.keys([\"name\", \"from_date\", \"to_date\", \"arguments\", \"environment_id\"]);","\tpm.expect(response.data.attributes.options).to.include({"," \"name\": pm.environment.get(\"extractor_name\"),","\t\t\"from_date\": -2,","\t\t\"to_date\": 0,","\t\t\"arguments\": \"arg3 arg4\"","\t});"," });","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"use_workflowstep_id\", response.data.id);","console.log('SET use_workflowstep_id: ' + pm.environment.get(\"use_workflowstep_id\"));","pm.environment.set(\"workflowstep_id\", response.data.id);","console.log('SET workflowstep_id: ' + pm.environment.get(\"workflowstep_id\"));"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"4cc34338-9cbe-4a29-9daa-7b945c19f3f3","exec":["const api = eval(pm.globals.get('exivity'))();\r","\r","api.start()\r"," .then(api.requireToken)\r"," .then(api.requireWorkflow)\r"," .then(api.requireExtractor)\r"," .then(api.ready)\r"," .catch(function(err) {\r"," console.log(err);\r","});\r","\r",""],"type":"text/javascript"}}],"id":"8b4969dd-dbb5-43cd-8963-acfe6767b172","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"},{"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\"type\": \"use\",\r\n\t\t\t\"timeout\": 600,\r\n\t\t\t\"options\": {\r\n\t\t\t\t\"name\": \"{{extractor_name}}\",\r\n\t\t\t\t\"from_date\": -2,\r\n\t\t\t\t\"to_date\": 0,\r\n\t\t\t\t\"arguments\": \"arg3 arg4\",\r\n \"environment_id\": null\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}}/v1/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":"Optionally 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.
On success, a HTTP 204 No Content success status response will be returned.
A workflow requires one or more steps. These steps are executed when a workflow is run.
\nLimit 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":null},{"description":{"content":"Optionally 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
⚠️ We plan to deprecate these endpoints in the next version of Exivity. A new /jobs endpoint will be added which will offer the same functionality.
Runs contain workflow status information of workflow runs.
\nThe following relationships can be included:
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5e9325f4-2802-48d8-b500-e73fa131a4d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a026a193-aec9-4bdc-84ab-ff5d0a27c104","type":"text/javascript","exec":[""]}}],"_postman_id":"f85bcd76-a3a7-43bc-9e3b-7fe8d5594b8a"},{"name":"/workflowsteplogs","item":[{"name":"Retrieve a list of workflow step logs","event":[{"listen":"prerequest","script":{"id":"5437bce0-054a-4e27-a487-d89712cf7c02","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":"08f4b1f9-abcb-4591-b091-c2ed86c30561","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":"f3e0a151-9201-442d-a920-ed8a72843583","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}}/v1/workflowsteplogs?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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.
⚠️ We plan to deprecate these endpoints in the next version of Exivity. A new /jobs endpoint will be added which will offer the same functionality.
Possible values: subscriptions, user.
On success, a HTTP 204 No Content success status response will be returned.
Notifications 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3cf6d562-ac72-44d1-89cf-6258820941ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3926a2c1-7159-4d3a-a8d3-f70b9de6276e","type":"text/javascript","exec":[""]}}],"_postman_id":"e5c97e74-7d78-489d-a527-4296a7794791"},{"name":"/notificationsubscriptions","item":[{"name":"Get all notifications subscriptions","event":[{"listen":"test","script":{"id":"84f406f5-5506-4ad6-98b7-3302723b96d6","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":"8895056e-9004-4303-8c20-f01c926327c3","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}}/v1/notificationsubscriptions","urlObject":{"path":["v1","notificationsubscriptions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8895056e-9004-4303-8c20-f01c926327c3"},{"name":"Create new notification subscription","event":[{"listen":"test","script":{"id":"10734244-7a2e-410d-90cc-f280b9288642","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(201);","});","","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('notificationsubscription');"," pm.expect(response.data.attributes).to.be.an('object');","});","","pm.environment.set(\"notification_subscritpion_id\", response.data.id);","console.log('SET notification_subscritpion_id: ' + pm.environment.get(\"notification_subscritpion_id\"));",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"8eac2dde-9d32-48e7-aeaf-b29eefc6be32","exec":["\r","if (!pm.environment.get(\"notification_channel_id\")) {\r"," console.log('No channel ID set - create a new channel');\r","\r"," // Create a new channel\r"," pm.sendRequest({\r"," url: pm.variables.get(\"base_url\") + '/v1/notificationchannels',\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\"data\": {\r"," \"type\":\"notificationchannel\",\r"," \"attributes\": {\r"," \"type\": \"mail\",\r"," \"name\": \"E-mail for someone\",\r"," \"info\": {\r"," \t\"recipient\": \"someone@exivity.com\"\r"," }\r"," },\r"," \"relationships\": {\r"," \t\"user\": {\r"," \t\t\"data\": {\r"," \t\t\t\"type\": \"user\",\r"," \t\t\t\"id\": pm.variables.get(\"user_id\")\r"," \t\t}\r"," \t}\r"," }\r"," }\r"," })\r"," }\r"," }, function(error, response) {\r"," if (error) {\r"," console.log(\"Error: \" + error);\r"," } else {\r"," pm.expect(response).to.have.property('code', 201);\r"," json = response.json();\r"," pm.environment.set(\"notification_channel_id\", json.data.id);\r"," console.log('SET notification_channel_id: ' + pm.environment.get(\"notification_channel_id\"));\r"," }\r"," });\r","}\r","\r",""],"type":"text/javascript"}}],"id":"9ee9759d-558f-4a13-b928-4adeb86148ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n \"type\":\"notificationsubscription\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"workflow_ended\",\n \"info\": {\n \t\"follow\": [\"*\"],\n \t\"only_status\": [\"successful\", \"failed\"]\n }\n },\n \"relationships\": {\n \t\"user\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"user\",\n \t\t\t\"id\": \"{{user_id}}\"\n \t\t}\n \t},\n \t\"channels\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"channel\",\n \t\t\t\"id\": \"{{notification_channel_id}}\"\n \t\t}\n \t}\n }\n }\n}"},"url":"{{base_url}}/v1/notificationsubscriptions","urlObject":{"path":["v1","notificationsubscriptions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"21e1ab38-79ef-4ae4-b92b-110dedd735fe","name":"Create new report_published notificaiton subscription","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n \"type\":\"notificationsubscription\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"report_published\",\n \"info\": {\n \"report_id\": 2,\n \"report_type\": \"separate\",\n \"account_depth\": 1,\n \"date_settings\": \"previous_month\",\n \"format\": \"csv\"\n }\n },\n \"relationships\": {\n \t\"user\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"user\",\n \t\t\t\"id\": \"{{user_id}}\"\n \t\t}\n \t}\n }\n }\n}"},"url":"{{base_url}}/v1/notificationsubscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 19 Jan 2021 09:49:37 GMT"},{"key":"Date","value":"Tue, 19 Jan 2021 09:49:37 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/1/notificationsubscription/5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"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-HBpMKpiNcU9ZErVkLyeeqX77rCcUYmhj';style-src 'self' 'nonce-HBpMKpiNcU9ZErVkLyeeqX77rCcUYmhj';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"notificationsubscription\",\n \"id\": \"5\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"report_published\",\n \"enabled\": true,\n \"info\": {\n \"report_id\": 2,\n \"report_type\": \"separate\",\n \"account_depth\": 1,\n \"date_settings\": \"previous_month\",\n \"format\": \"csv\"\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscriptions/5\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscription/5/relationships/user\",\n \"related\": \"http://localhost:8012/1/notificationsubscription/5/user\"\n }\n },\n \"channels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscription/5/relationships/channels\",\n \"related\": \"http://localhost:8012/1/notificationsubscription/5/channels\"\n }\n }\n }\n }\n}"},{"id":"2eff1162-a0f7-4727-a5b6-e792a0f2e25c","name":"Create workflow subscription with file attachement","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n \"type\":\"notificationsubscription\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"workflow.ended\",\n \"info\": {\n \t\"follow\": [\"*\"],\n \t\"only_status\": [\"successful\", \"failed\"],\n \"files\": {\n \"filename\": [\"extractor_[0-9]{,2}\\\\.[a-z0-9]{2,4}\", \"transformer_[0-9]{,2}\\\\.[a-z0-9]{2,4}\"],\n \"edited_since_workflow_started\": true,\n \"compress_attachments\": false\n }\n }\n },\n \"relationships\": {\n \t\"user\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"user\",\n \t\t\t\"id\": \"{{user_id}}\"\n \t\t}\n \t},\n \t\"channels\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"channel\",\n \t\t\t\"id\": \"{{notification_channel_id}}\"\n \t\t}\n \t}\n }\n }\n}"},"url":"{{base_url}}/v1/notificationsubscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Thu, 01 Oct 2020 13:56:50 GMT"},{"key":"Date","value":"Thu, 01 Oct 2020 13:56:50 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/1/notificationsubscription/4"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"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-fbRtUtOlOS4kJT8Yo6ukBsG3NWXYLU6i';style-src 'self' 'nonce-fbRtUtOlOS4kJT8Yo6ukBsG3NWXYLU6i';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"notificationsubscription\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"workflow_ended\",\n \"enabled\": true,\n \"info\": {\n \"follow\": [\n \"*\"\n ],\n \"only_status\": [\n \"successful\",\n \"failed\"\n ],\n \"files\": {\n \"filename\": [\n \"extractor_[0-9]{,2}\\\\.[a-z0-9]{2,4}\",\n \"transformer_[0-9]{,2}\\\\.[a-z0-9]{2,4}\"\n ],\n \"edited_since_workflow_started\": true,\n \"compress_attachments\": false\n }\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscriptions/4\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscription/4/relationships/user\",\n \"related\": \"http://localhost:8012/1/notificationsubscription/4/user\"\n }\n }\n }\n }\n}"},{"id":"9411375b-13dd-4907-8bd8-0f49491e487b","name":"Create new budget_evaluated notificaiton subscription","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n \"type\":\"notificationsubscription\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"budget_evaluated\",\n \"info\": {\n \"budget_id\": 1,\n \t\"threshold_percentage\": 80,\n \"only_once\": true,\n \"account_ids\": [1,2,3]\n }\n },\n \"relationships\": {\n \t\"user\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"user\",\n \t\t\t\"id\": \"{{user_id}}\"\n \t\t}\n \t},\n \t\"channels\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"channel\",\n \t\t\t\"id\": \"{{notification_channel_id}}\"\n \t\t}\n \t}\n }\n }\n}"},"url":"{{base_url}}/v1/notificationsubscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 18 Jan 2021 10:33:17 GMT"},{"key":"Date","value":"Mon, 18 Jan 2021 10:33:17 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/1/notificationsubscription/4"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"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-cYInKv7lTnjmgmgCFHZ4bpNFN91Naz9a';style-src 'self' 'nonce-cYInKv7lTnjmgmgCFHZ4bpNFN91Naz9a';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"notificationsubscription\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"budget_evaluated\",\n \"enabled\": true,\n \"info\": {\n \"budget_id\": 1,\n \"threshold_percentage\": 80,\n \"only_once\": true,\n \"account_ids\": [\n 1,\n 2,\n 3\n ]\n }\n },\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscriptions/4\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscription/4/relationships/user\",\n \"related\": \"http://localhost:8012/1/notificationsubscription/4/user\"\n }\n },\n \"channels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/1/notificationsubscription/4/relationships/channels\",\n \"related\": \"http://localhost:8012/1/notificationsubscription/4/channels\"\n }\n }\n }\n }\n}"},{"id":"a8b3f8c4-51b2-46f6-81cc-f4491fdcfb2b","name":"Create a new notification subscription with channel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n \"type\":\"notificationsubscription\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"workflow.ended\",\n \"info\": {\n \t\"follow\": [\"*\"],\n \t\"only_status\": [\"successful\", \"failed\"]\n }\n },\n \"relationships\": {\n \t\"user\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"user\",\n \t\t\t\"id\": \"{{user_id}}\"\n \t\t}\n \t},\n \t\"channels\": {\n \t\t\"data\": {\n \t\t\t\"type\": \"channel\",\n \t\t\t\"id\": \"{{notification_channel_id}}\"\n \t\t}\n \t}\n }\n }\n}"},"url":"{{base_url}}/v1/notificationsubscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 18 Mar 2019 14:58:01 +0000"},{"key":"Date","value":"Mon, 18 Mar 2019 14:58:01 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.1.21"},{"key":"Location","value":"https://localhost:8012/v1/notificationsubscription/7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Access-Control-Allow-Origin","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"notificationsubscription\",\n \"id\": \"7\",\n \"attributes\": {\n \"name\": \"Important workflow has ended\",\n \"type\": \"workflow.ended\",\n \"info\": {\n \"follow\": [\n \"*\"\n ],\n \"only_status\": [\n \"successful\",\n \"failed\"\n ]\n }\n },\n \"links\": {\n \"self\": \"https://localhost:8012/v1/notificationsubscriptions/7\"\n }\n }\n}"}],"_postman_id":"9ee9759d-558f-4a13-b928-4adeb86148ca"},{"name":"Get a notification subscription by ID","event":[{"listen":"test","script":{"id":"01c26907-02bd-4095-95bc-7fe1af628eb4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response has a valid JSON body\", function () {"," pm.response.to.be.withBody;"," pm.response.to.be.json;","});","","const response = pm.response.json();","console.log(response);","","// Check Json","pm.test(\"Response contains data\", function () {"," pm.expect(response.data).to.be.an('object');","});","","","pm.test(\"Response has valid attributes\", function() {"," pm.expect(response).to.have.property('data');"," pm.expect(response.data).to.have.property('id');"," pm.expect(response.data).to.have.property('type');"," pm.expect(response.data.type).to.be.eql('notificationsubscription');"," pm.expect(response.data).to.have.property('attributes');"," pm.expect(response.data).to.have.property('links');"," pm.expect(response.data).to.have.property('relationships');","});"," "],"type":"text/javascript"}}],"id":"ddb146ec-1857-4b6d-a220-8be5b31b5260","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}}/v1/notificationsubscriptions/{{notification_subscritpion_id}}?include=channels","urlObject":{"path":["v1","notificationsubscriptions","{{notification_subscritpion_id}}"],"host":["{{base_url}}"],"query":[{"key":"include","value":"channels"}],"variable":[]}},"response":[],"_postman_id":"ddb146ec-1857-4b6d-a220-8be5b31b5260"},{"name":"Edit a notification subscription","event":[{"listen":"test","script":{"id":"9c254afb-3b8a-4389-a935-40ecd4336522","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":"6cc73bab-8d1f-466b-b611-e67c59b89e13","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","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"type\": \"notificationsubscription\",\r\n\t\t\"id\": \"{{notification_subscritpion_id}}\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"Super important budget overruns\"\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/notificationsubscriptions/{{notification_subscritpion_id}}","urlObject":{"path":["v1","notificationsubscriptions","{{notification_subscritpion_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cc73bab-8d1f-466b-b611-e67c59b89e13"},{"name":"Delete a notification subscription","event":[{"listen":"test","script":{"id":"b80ebb0a-52ba-49f3-bc01-265fa0edef69","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","// Delete the variable","console.log('UNSET notification_subscritpion_id');","pm.environment.unset(\"notification_subscritpion_id\");",""],"type":"text/javascript"}}],"id":"3d156ddf-71d1-4130-b095-bd1260b7301a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/notificationsubscriptions/{{notification_subscritpion_id}}","description":"On success, a HTTP 204 No Content success status response will be returned.
Notifications 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","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"794a206e-780f-44a5-8c64-5adbe180fa16","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"93a39f1c-4a9f-48ee-bd77-d61084b5cf00","type":"text/javascript","exec":[""]}}],"_postman_id":"346db218-57a6-400c-85fb-34d847da24b0"},{"name":"/notifications","item":[{"name":"Get all database notification","event":[{"listen":"test","script":{"id":"09a0c7dc-3228-45a2-9f3c-6060f7777ebe","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":"bb06302f-127a-4f71-9fa4-2e62522bb58c","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}}/v1/notifications","description":"Get all database notification for auth user
\n","urlObject":{"path":["v1","notifications"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb06302f-127a-4f71-9fa4-2e62522bb58c"}],"id":"9add9ff9-39f6-451a-971f-7f2f09d07e7e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"27592118-418b-46e1-b78b-220db6819f01","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03fca8c0-d8a9-49c5-b1ca-8231b72f55d6","type":"text/javascript","exec":[""]}}],"_postman_id":"9add9ff9-39f6-451a-971f-7f2f09d07e7e","description":""}],"id":"200943b9-5cca-443e-bdb4-27d9fff54501","auth":{"type":"noauth","isInherited":false},"_postman_id":"200943b9-5cca-443e-bdb4-27d9fff54501","description":""},{"name":"Administration","item":[{"name":"/users","item":[{"name":"/users/me","item":[{"name":"Retrieve the current user","event":[{"listen":"test","script":{"id":"78fd66fb-62f9-46c3-ae3a-380572d44554","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":"c5f5ac48-fe62-4cc2-aef1-bc37ec6d9113","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":"d80b7694-8ce8-ab7c-24a2-8f38deba8eee","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}}/v1/users/me","urlObject":{"path":["v1","users","me"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d80b7694-8ce8-ab7c-24a2-8f38deba8eee"},{"name":"Update the current user","event":[{"listen":"test","script":{"id":"b7299b10-8228-4b15-8e1c-c440ba059ab9","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(\"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.eql('admin');"," pm.expect(response.data.attributes.email_address).to.eql('tester@exivity.com');","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"761c676d-26cc-9a13-e3cb-8d2571bf67f3","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\": \"user\",\r\n \"id\": \"{{user_id}}\",\r\n \"attributes\": {\r\n \"email_address\": \"tester@exivity.com\",\r\n \"current_password\": \"exivity\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/users/me","urlObject":{"path":["v1","users","me"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9da1e752-027c-46ce-b688-53399bcb509d","name":"Update the current user password","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\": \"user\",\r\n \"id\": \"{{user_id}}\",\r\n \"attributes\": {\r\n \"password\": \"new_password\"\r\n \"current_password\": \"old_password\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/users/me"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"761c676d-26cc-9a13-e3cb-8d2571bf67f3"},{"name":"Generate a new key","event":[{"listen":"test","script":{"id":"b7299b10-8228-4b15-8e1c-c440ba059ab9","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.result).to.be.a('string');"," pm.expect(response.result).to.eql('rotated');","});"],"type":"text/javascript"}}],"id":"f9ec946a-4d5b-4cfe-bff5-cfd0e320afc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"{{base_url}}/v1/users/me/key","description":"⚠️ Available since v3.0.0.
\nThis will invalidate all previously issued tokens.
\n","urlObject":{"path":["v1","users","me","key"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9ec946a-4d5b-4cfe-bff5-cfd0e320afc1"},{"name":"Update the current users app state","event":[{"listen":"test","script":{"id":"09a39f7e-ecec-43c2-99a7-b948187a1edd","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":"0b79d903-38a4-402f-9bad-87cbd4320a59","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":"954f38ca-d6c5-4541-9573-4bd73293cc09","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}}/v1/users/me/state?app=glass","urlObject":{"path":["v1","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":"Optionally filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":null},{"description":{"content":"Include additional related resources. Possible values: usergroup, accounts.
Include additional related resources. Possible values: usergroup, accounts, channels, notificationsubscriptions.
⚠️ Available since v3.0.0.
\nThis will invalidate all previously issued tokens.
\n","urlObject":{"path":["v1","users","{{new_user_id}}","key"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"96fd2e9b-b959-4e6c-a8a5-06c40483598c"},{"name":"Update a user","event":[{"listen":"test","script":{"id":"2012e4e8-aec3-467a-b60d-faeb3c8cb4cd","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":"4e87d63e-9383-c548-b212-aeea5aa1270d","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 - 926\",\r\n \"email_address\": \"someone+modified_757@exivity.com\",\r\n \"account_access_type\": \"all\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/users/{{new_user_id}}","urlObject":{"path":["v1","users","{{new_user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8a51fcb1-975b-4c5b-bd7a-a444a80bc6dc","name":"Update a user's source to LDAP","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 \"source\": \"ldap\"\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/users/{{new_user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Tue, 09 Nov 2021 16:20:01 GMT"},{"key":"Date","value":"Tue, 09 Nov 2021 16:20:01 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"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-deA0a21he0JbtFJxaHyEB83rQFyLn7Qt';style-src 'self' 'nonce-deA0a21he0JbtFJxaHyEB83rQFyLn7Qt';font-src 'self' data:"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"user\",\n \"id\": \"4deaa843-6c62-4534-97b6-27bbf29d7ad8\",\n \"attributes\": {\n \"username\": \"modified_user - 700\",\n \"email_address\": \"someone+modified_504@exivity.com\",\n \"account_access_type\": \"all\",\n \"source\": \"ldap\",\n \"display_name\": \"modified_user - 700\"\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8\"\n },\n \"relationships\": {\n \"usergroup\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/relationships/usergroup\",\n \"related\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/usergroup\"\n }\n },\n \"accounts\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/relationships/accounts\",\n \"related\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/accounts\"\n }\n },\n \"channels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/relationships/channels\",\n \"related\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/channels\"\n }\n },\n \"notificationchannels\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/relationships/notificationchannels\",\n \"related\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/notificationchannels\"\n }\n },\n \"notificationsubscriptions\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/relationships/notificationsubscriptions\",\n \"related\": \"http://localhost:8012/v1/users/4deaa843-6c62-4534-97b6-27bbf29d7ad8/notificationsubscriptions\"\n }\n }\n }\n }\n}"}],"_postman_id":"4e87d63e-9383-c548-b212-aeea5aa1270d"},{"name":"Delete a user","event":[{"listen":"test","script":{"id":"76192ac4-5dad-4027-8f46-36932f8cf5a3","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":"918cd8ca-a9d9-51ee-b51f-9241939ed239","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}}/v1/users/{{new_user_id}}","urlObject":{"path":["v1","users","{{new_user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"918cd8ca-a9d9-51ee-b51f-9241939ed239"}],"id":"8869248e-edd9-0b19-023d-cc27e4b5eba6","description":"Everyone 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.
\nOptionally filter results by this attribute
\n","type":"text/plain"},"key":"filter[attribute]","value":""}],"variable":[]}},"response":[],"_postman_id":"9cbb9dc2-2de6-12a6-0a4f-dc991f9c35d8"},{"name":"Add a new usergroup","event":[{"listen":"test","script":{"id":"01f37b5a-a98f-4f9b-b8f5-e3286935b7ad","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('usergroup');"," pm.expect(response.data.id).to.not.be.undefined;"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.have.keys(["," \"name\","," \"permissions\""," ]);"," pm.expect(response.data.attributes.name).to.eql('testers');"," pm.expect(response.data.attributes.permissions).to.eql(['manage_users']);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});","","pm.environment.set(\"usergroup_id\", response.data.id);"],"type":"text/javascript"}}],"id":"0be8c767-4ef8-fe9c-52de-d03c5bedca68","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\": \"usergroup\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"testers\",\r\n\t\t\t\"permissions\": [\"manage_users\"]\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/usergroups","urlObject":{"path":["v1","usergroups"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1be8877e-41d8-4e97-829e-f881435aa369","name":"Add a new usergroup","originalRequest":{"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\": \"usergroup\",\r\n\t\t\"attributes\": {\r\n\t\t\t\"name\": \"testers\",\r\n\t\t\t\"permissions\": [\"manage_users\"]\r\n\t\t}\r\n\t}\r\n}"},"url":"{{base_url}}/v1/usergroups"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:40:11 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:40:11 GMT"},{"key":"Connection","value":"close"},{"key":"Location","value":"http://localhost:8012/v1/Usergroup/Usergroups"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"X-Clockwork-Id","value":"X323af56c4fb301e0486c88f7c4cf7d0f"},{"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-gv1trTAypt554N11EfFQfK9dcSjC6qST';style-src 'self' 'nonce-gv1trTAypt554N11EfFQfK9dcSjC6qST';font-src 'self' data:"},{"key":"Request-Id","value":"a0b70752-55d1-419c-84f6-9172f8cdb7b8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"usergroup\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"testers\",\n \"permissions\": [\n \"manage_users\"\n ]\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/2\"\n },\n \"relationships\": {\n \"users\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/2/relationships/users\",\n \"related\": \"http://localhost:8012/v1/usergroups/2/users\"\n }\n }\n }\n }\n}"}],"_postman_id":"0be8c767-4ef8-fe9c-52de-d03c5bedca68"},{"name":"Retrieve a usergroup","event":[{"listen":"test","script":{"id":"e027a60e-90af-4fbe-b93d-b862f0e57e10","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('usergroup');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"usergroup_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.have.keys(["," \"name\","," \"permissions\""," ]);"," pm.expect(response.data.attributes.name).to.eql('testers');"," pm.expect(response.data.attributes.permissions).to.eql(['manage_users']);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"9d065b1d-c626-2825-9367-74cfdad33913","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}}/v1/usergroups/{{usergroup_id}}","urlObject":{"path":["v1","usergroups","{{usergroup_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5d5c80b2-8314-49f7-ba70-f762024cc552","name":"Retrieve a usergroup","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"{{base_url}}/v1/usergroups/{{usergroup_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:40:32 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:40:32 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":"X8e2cf05b5cd5d28f0319aed6d61ea6e4"},{"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-qcMmTIePg06esIKTgCSO8vmZl4fgiUjw';style-src 'self' 'nonce-qcMmTIePg06esIKTgCSO8vmZl4fgiUjw';font-src 'self' data:"},{"key":"Request-Id","value":"2909f9bd-0202-4722-acaa-3776609fef85"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"usergroup\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"testers\",\n \"permissions\": [\n \"manage_users\"\n ]\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/2\"\n },\n \"relationships\": {\n \"users\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/2/relationships/users\",\n \"related\": \"http://localhost:8012/v1/usergroups/2/users\"\n }\n }\n }\n }\n}"}],"_postman_id":"9d065b1d-c626-2825-9367-74cfdad33913"},{"name":"Update a usergroup","event":[{"listen":"test","script":{"id":"08b3b90c-34f2-40b1-8b33-8512aeb58810","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('usergroup');"," pm.expect(response.data.id).to.eql(pm.environment.get(\"usergroup_id\").toString());"," pm.expect(response.data.attributes).to.be.an('object');"," pm.expect(response.data.attributes).to.have.keys(["," \"name\","," \"permissions\""," ]);"," pm.expect(response.data.attributes.name).to.eql('modified_testers');"," pm.expect(response.data.attributes.permissions).to.eql(['manage_users','manage_settings']);","});","","pm.test(\"Response contains data.links\", function () {"," pm.expect(response.data.links).to.be.an('object');","});"],"type":"text/javascript"}}],"id":"f5b8914b-34d4-daa5-261d-ff8e218be950","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\": \"usergroup\",\r\n \"id\": \"{{usergroup_id}}\",\r\n \"attributes\": {\r\n\t\t\t\"name\": \"modified_testers\",\r\n\t\t\t\"permissions\": [\"manage_users\", \"manage_settings\"]\r\n\t\t}\r\n }\r\n}"},"url":"{{base_url}}/v1/usergroups/:usergroup_id","urlObject":{"path":["v1","usergroups",":usergroup_id"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"{{usergroup_id}}","key":"usergroup_id"}]}},"response":[{"id":"de083b3f-3dcb-448b-989a-fe23c0353363","name":"Add user to usergroup","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\": \"usergroup\",\r\n \"id\": \"{{usergroup_id}}\",\r\n \"relationships\": {\r\n \"users\": {\"data\": [\r\n {\"type\": \"user\", \"id\": \"54c61cde-8488-461a-96d1-e75db3f6df7d\"} \r\n ]}\r\n }\r\n }\r\n}"},"url":"{{base_url}}/v1/usergroups/{{usergroup_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Mon, 09 May 2022 10:28:21 GMT"},{"key":"Date","value":"Mon, 09 May 2022 10:28: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":"Xeb8203777b90fdf0e1e9f834b8aeb98e"},{"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-zu6uqk7kFL4mWW7Fyx99cPvEG6xL5x3B';style-src 'self' 'nonce-zu6uqk7kFL4mWW7Fyx99cPvEG6xL5x3B';font-src 'self' data:"},{"key":"Request-Id","value":"cfc5135e-02f5-41d7-adc9-b24e179a9399"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"usergroup\",\n \"id\": \"5\",\n \"attributes\": {\n \"name\": \"testers\",\n \"permissions\": [\n \"manage_users\"\n ]\n },\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/5\"\n },\n \"relationships\": {\n \"users\": {\n \"links\": {\n \"self\": \"http://localhost:8012/v1/usergroups/5/relationships/users\",\n \"related\": \"http://localhost:8012/v1/usergroups/5/users\"\n }\n }\n }\n }\n}"}],"_postman_id":"f5b8914b-34d4-daa5-261d-ff8e218be950"},{"name":"Delete a usergroup","event":[{"listen":"test","script":{"id":"170281b6-f19c-4dc0-be12-0494ca748b07","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});","","console.log('UNSET usergroup_id');","pm.environment.unset(\"usergroup_id\");"],"type":"text/javascript"}}],"id":"086ad41d-6c5c-97f9-d6b0-6e36cb971aa8","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}}/v1/usergroups/{{usergroup_id}}","description":"On success, a HTTP 204 No Content success status response will be returned.
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
\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:
\nThe system can be configured using these endpoints.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"097248e9-69a2-4b86-bd0e-566c8fc937a3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e8f3a47-64ba-4901-9269-8aa9dc2970ce","type":"text/javascript","exec":[""]}}],"_postman_id":"dcc7d52d-c5f5-35bd-a28b-182dbba9eec3"},{"name":"/audit","item":[{"name":"Get audit trail","event":[{"listen":"test","script":{"id":"c7f4eb4c-29a7-466a-9f97-74f1927d007b","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.audit).to.be.an('array');","});"],"type":"text/javascript","packages":{}}}],"id":"5c020eb1-a7d9-8a0a-0608-a1fa08981f97","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}}/v1/audit?start=&end&page[limit]&page[offset]&sort&filter[attribute]","urlObject":{"path":["v1","audit"],"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.
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":"310cf0fe-54db-4ec8-a124-880becac02ee","name":"Get audit trail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v1/audit?start=&end","host":["{{base_url}}"],"path":["v1","audit"],"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":null,"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."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:42:26 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:42:26 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"Xbd735fb17da1598c1b617ec8c413c3c5"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"Xbd735fb17da1598c1b617ec8c413c3c5"},{"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-DH2PEZATWmaGBgxCM53PwH7iDkQeZrea';style-src 'self' 'nonce-DH2PEZATWmaGBgxCM53PwH7iDkQeZrea';font-src 'self' data:"},{"key":"Request-Id","value":"11e17ef9-bb2f-41ac-8997-2044a10914b0"}],"cookie":[],"responseTime":null,"body":"{\n \"audit\": [\n {\n \"id\": 1,\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"component\": \"proximity\",\n \"category\": \"usergroup\",\n \"action\": \"create\",\n \"message\": \"Usergroup 'admins' with id=1 created\",\n \"created_at\": \"2022-02-04T09:07:26Z\"\n },\n {\n \"id\": 2,\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"component\": \"proximity\",\n \"category\": \"user\",\n \"action\": \"create\",\n \"message\": \"User 'admin' with id=469e01d8-1c95-4923-8bc6-1aebfdf30bc8 created\",\n \"created_at\": \"2022-02-04T09:07:27Z\"\n }\n ]\n}"}],"_postman_id":"5c020eb1-a7d9-8a0a-0608-a1fa08981f97"}],"id":"531d4b13-3f22-c6de-c996-5b523af6cc9e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"350aeac8-afe4-4111-bc5c-0e1ec558db46","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3c5a15db-401b-4689-8e52-39b6b240762d","type":"text/javascript","exec":[""]}}],"_postman_id":"531d4b13-3f22-c6de-c996-5b523af6cc9e","description":""},{"name":"/log","item":[{"name":"Retrieve logfiles","event":[{"listen":"test","script":{"id":"32f3e0ad-b589-4197-94b8-85e8e0fb3ea5","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.logfiles).to.be.an('array');","});","","// 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":"e2d16e1f-efc0-4d6b-80a0-b488a0ea9d92","exec":["const component = pm.environment.get(\"component\");","","if (!component) {"," pm.environment.set(\"component\", \"proximity\");","}"],"type":"text/javascript"}}],"id":"8f550f28-8abc-e09b-628a-54fa0f090db7","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}}/v1/log?component=use","urlObject":{"path":["v1","log"],"host":["{{base_url}}"],"query":[{"description":{"content":"Required, in: use, transcript, edify, proximity, chronos, pigeon, horizon, merlin, griffon
\n","type":"text/plain"},"key":"component","value":"use"}],"variable":[]}},"response":[{"id":"cfeebcd6-3f12-4048-8e09-6f285f7cd32a","name":"Retrieve logfiles","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/v1/log?component=use&limit=&filter=&truncate=","host":["{{base_url}}"],"path":["v1","log"],"query":[{"key":"component","value":"use","description":"The component to receive the logfiles for, can be `use`, `transcript`, `edify`, `chronos`, `proximity`, `pigeon`, `horizon`, `merlin` or `griffon`."},{"key":"limit","value":"","description":"Limit the maximum number of logfiles to return. Defaults to `100`."},{"key":"filter","value":"","description":"Optionally filter the logfiles by filename. Use the asterisk (`*`) for wildcard matching."},{"key":"truncate","value":"","description":"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`."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8012"},{"key":"Date","value":"Fri, 04 Feb 2022 10:43:45 GMT"},{"key":"Date","value":"Fri, 04 Feb 2022 10:43:45 GMT"},{"key":"Connection","value":"close"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"X-Clockwork-Id","value":"X0f122269ff964353786cbc4fff1c7831"},{"key":"X-Clockwork-Version","value":"1"},{"key":"X-Clockwork-Path","value":"_debugbar/clockwork/"},{"key":"phpdebugbar-id","value":"X0f122269ff964353786cbc4fff1c7831"},{"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-cmsbVJxxI00gD7AjOZboZDAtPfNh6RHm';style-src 'self' 'nonce-cmsbVJxxI00gD7AjOZboZDAtPfNh6RHm';font-src 'self' data:"},{"key":"Request-Id","value":"9cd267cb-12f9-4ee2-aa23-e3f811aa004a"}],"cookie":[],"responseTime":null,"body":"\n{\n \"logfiles\": [\n {\n \"filename\": \"proximity-2022-02-04.log\",\n \"created\": \"2022-02-04T08:53:05Z\",\n \"metadata\": [],\n \"lines\": [\n {\n \"date\": \"2022-02-04T08:53:05.260+00:00\",\n \"level\": 200,\n \"message\": \"App\\\\Audit::write\",\n \"metadata\": {\n \"appName\": \"local\",\n \"request-id\": \"b05307d1-dfc7-4d43-b1af-73b73c921c86\",\n \"message\": \"Failed login attempt for 'admin' from ::1\",\n \"url\": \"/v1/auth/token?app=\",\n \"ip\": \"::1\",\n \"http_method\": \"POST\",\n \"server\": \"localhost\",\n \"referrer\": null\n }\n },\n {\n \"date\": \"2022-02-04T10:04:30.640+00:00\",\n \"level\": 200,\n \"message\": \"The name has already been taken.\",\n \"metadata\": {\n \"appName\": \"local\",\n \"request-id\": \"b721bf44-973d-4531-999a-3b5fcd6862f0\",\n \"rules\": {\n \"name\": \"required|string|unique:metadata_definition,name\",\n \"fields\": \"required|array\",\n \"fields.*.name\": \"required|string\",\n \"fields.*.type\": \"required|in:string,list,numeric,date\",\n \"fields.*.list\": \"required_if:fields.*.type,list\"\n },\n \"url\": \"/v1/metadatadefinitions\",\n \"ip\": \"::1\",\n \"http_method\": \"POST\",\n \"server\": \"localhost\",\n \"referrer\": null\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"8f550f28-8abc-e09b-628a-54fa0f090db7"}],"id":"6305942f-64a3-6d05-3b3a-e5334cdbf321","description":"Exivity offers the possibility to get insight into the log files of different components. This feature enables the users to identify any potential errors on their own, making the overall troubleshooting process smoother.
\nExivity documentation: https://docs.exivity.com/troubleshooting/logs
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"57c71046-3f9e-4bc7-99c4-317729503378","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb143f19-619d-4af1-832e-19773c23be90","type":"text/javascript","exec":[""]}}],"_postman_id":"6305942f-64a3-6d05-3b3a-e5334cdbf321"},{"name":"/dump","item":[{"name":"Get a full data dump","event":[{"listen":"test","script":{"id":"4ef46d69-e7d3-4168-a7c9-e20b4535b27b","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"0778327e-6143-98a6-3df4-c2727a16ff18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"text/csv","description":"Specify either text/csv or application/json.
\n"}],"url":"{{base_url}}/v1/dump/data?models=&progress","urlObject":{"path":["v1","dump","data"],"host":["{{base_url}}"],"query":[{"description":{"content":"Optionally provide a comma separated list of models to include.
\n","type":"text/plain"},"key":"models","value":""},{"description":{"content":"Use progress separators within dump, can be 0 or 1. Defaults to 1.
\n","type":"text/plain"},"key":"progress","value":null}],"variable":[]}},"response":[],"_postman_id":"0778327e-6143-98a6-3df4-c2727a16ff18"}],"id":"3d388714-3dd3-4725-9a9e-d34f1b59ca06","auth":{"type":"noauth","isInherited":false},"_postman_id":"3d388714-3dd3-4725-9a9e-d34f1b59ca06","description":""},{"name":"/system","item":[{"name":"/licence","item":[{"name":"Check licence","event":[{"listen":"test","script":{"id":"fb73b126-8d44-4004-accf-9992d335fd3e","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).to.have.keys(["," \"status\","," \"message\","," \"hash\","," \"expiresAfter\","," \"payload\","," ]);","});"],"type":"text/javascript"}}],"id":"ff008753-124d-0d0f-f958-cb0864a7298f","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}}/v1/system/licence","urlObject":{"path":["v1","system","licence"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2be0e368-59fb-f07a-79ba-d826670260e7","name":"Check licence","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","disabled":false}],"url":"{{base_url}}/v1/system/licence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"cache-control","value":"no-cache, private","name":"cache-control","description":""},{"key":"connection","value":"close","name":"connection","description":""},{"key":"content-type","value":"application/json","name":"content-type","description":""},{"key":"date","value":"Wed, 14 Feb 2018 10:27:15 +0000, Wed, 14 Feb 2018 10:27:15 GMT","name":"date","description":""},{"key":"host","value":"localhost:8002","name":"host","description":""},{"key":"phpdebugbar-id","value":"a089800cd6c1b11c33b854a251694d98","name":"phpdebugbar-id","description":""},{"key":"x-powered-by","value":"PHP/7.1.4","name":"x-powered-by","description":""}],"cookie":[],"responseTime":"143","body":"{\"status\":\"expired\",\"message\":\"The current license was valid until January 31, 2017.\",\"hash\":\"4062176ea1471472332ab3afbc2d5dc58af621b7\",\"expiresAfter\":\"2017-01-31\",\"payload\":{\"start\":\"2017-01-01\",\"end\":\"2017-01-31\",\"type\":\"all\",\"limits\":{\"account_limit\":\"1\",\"service_limit\":\"1\"}}}"}],"_postman_id":"ff008753-124d-0d0f-f958-cb0864a7298f"},{"name":"Update licence","event":[{"listen":"test","script":{"id":"c9b532f1-f969-4c8f-84f4-9800455a3a23","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).to.have.keys(["," \"status\","," \"message\","," \"hash\","," \"expiresAfter\","," \"payload\","," ]);","});"],"type":"text/javascript"}}],"id":"ee61114a-c006-4959-a85c-68250a855779","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":"{\n \"licence\": \"{{licence}}\"\n}"},"url":"{{base_url}}/v1/system/licence","urlObject":{"path":["v1","system","licence"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a5ca2013-fade-470f-96ff-9ff1d23673e8","name":"Update licence","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"license\": \"{{licence}}\"\n}"},"url":"{{base_url}}/v1/system/licence"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"cache-control","value":"no-cache, private","name":"cache-control","description":""},{"key":"connection","value":"close","name":"connection","description":""},{"key":"content-type","value":"application/json","name":"content-type","description":""},{"key":"date","value":"Wed, 14 Feb 2018 10:23:47 +0000, Wed, 14 Feb 2018 10:23:47 GMT","name":"date","description":""},{"key":"host","value":"localhost:8002","name":"host","description":""},{"key":"phpdebugbar-id","value":"c6b7d899a9439eb8ec11ed209dd47c69","name":"phpdebugbar-id","description":""},{"key":"x-powered-by","value":"PHP/7.1.4","name":"x-powered-by","description":""}],"cookie":[],"responseTime":null,"body":"{ \"status\": \"valid\", \"message\": \"The current licence is valid until July 1, 2027.\", \"hash\": \"83b44524e07b8cb94f110010dd15fa82b352d1fa\", \"expiresAfter\": \"2027-07-01\", \"payload\": { \"_version\": \"1\", \"start\": \"2021-06-01\", \"end\": \"2027-07-01\", \"limits\": \"{}\" } }"}],"_postman_id":"ee61114a-c006-4959-a85c-68250a855779"}],"id":"4c327b76-ee10-fe5a-3fb1-c7d7453864e2","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"cde91eaa-49ff-4015-b9d2-047091fd199d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"20396de3-4105-4e77-bfca-a121323d4c72","type":"text/javascript","exec":[""]}}],"_postman_id":"4c327b76-ee10-fe5a-3fb1-c7d7453864e2","description":""},{"name":"/cache","item":[{"name":"Get cache information","event":[{"listen":"test","script":{"id":"fc12b936-c455-4ec8-8b52-55ceb5060a36","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(["," \"proximity\","," \"edify\","," ]);","});"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"bcebacd6-6323-414f-a421-7ce6af605645","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":"49d3aa19-ff86-26bd-c58b-d7704eee81a1","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}}/v1/system/cache","urlObject":{"path":["v1","system","cache"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a5241eee-fe6c-013b-06ad-4d6d2366ad0e","name":"Get cache information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/system/cache"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""},{"key":"cache-control","value":"no-cache, private","name":"cache-control","description":""},{"key":"connection","value":"close","name":"connection","description":""},{"key":"content-type","value":"application/json","name":"content-type","description":""},{"key":"date","value":"Wed, 14 Feb 2018 10:30:01 +0000, Wed, 14 Feb 2018 10:30:01 GMT","name":"date","description":""},{"key":"host","value":"localhost:8002","name":"host","description":""},{"key":"phpdebugbar-id","value":"df70786eedbca0f8fa5fae6872d8321c","name":"phpdebugbar-id","description":""},{"key":"x-powered-by","value":"PHP/7.1.4","name":"x-powered-by","description":""}],"cookie":[],"responseTime":"141","body":"{\"data\":{\"proximity\":{\"size\":\"(not running)\"},\"edify\":{\"size\":\"(unknown)\"}}}"}],"_postman_id":"49d3aa19-ff86-26bd-c58b-d7704eee81a1"},{"name":"Delete cache","event":[{"listen":"test","script":{"id":"6575058c-5059-42ab-94f9-0e8d8c952d78","exec":["pm.test(\"Status code is 204\", function () {"," pm.response.to.have.status(204);","});"],"type":"text/javascript"}}],"id":"9cac764c-f8dc-5103-f963-1169a20585cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/v1/system/cache?component","urlObject":{"path":["v1","system","cache"],"host":["{{base_url}}"],"query":[{"description":{"content":"Optionally 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.
⚠️ This endpoint is deprecated and may be removed in future versions of Exivity.
\n","urlObject":{"path":["v1","translations",":locale",":filename"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"ISO 639-1 two letter code representation of names of language
\n","type":"text/plain"},"type":"string","value":"en","key":"locale"},{"type":"string","value":"words","key":"filename"}]}},"response":[],"_postman_id":"4238e088-4c00-4405-b257-3407a99bc19f"},{"name":"Get translation","event":[{"listen":"test","script":{"id":"0500390f-a1a9-475f-8bf7-48d7ad8252cf","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","","pm.test(\"Response contains configuration data\", function () {"," pm.expect(response).to.be.an('object');"," pm.expect(response.data).to.be.an('object');","});",""],"type":"text/javascript"}}],"id":"8ce8a5d3-cf35-4fe3-ace2-4d02041fdd56","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}}/v1/translations/:locale/:filename","description":"⚠️ This endpoint is deprecated and may be removed in future versions of Exivity.
\n","urlObject":{"path":["v1","translations",":locale",":filename"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"ISO 639-1 two letter code representation of names of language
\n","type":"text/plain"},"type":"string","value":"en","key":"locale"},{"type":"string","value":"words","key":"filename"}]}},"response":[],"_postman_id":"8ce8a5d3-cf35-4fe3-ace2-4d02041fdd56"},{"name":"Update translation","event":[{"listen":"test","script":{"id":"0500390f-a1a9-475f-8bf7-48d7ad8252cf","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","const response = pm.response.json();","","pm.test(\"Response contains configuration data\", function () {"," pm.expect(response).to.be.an('object');"," pm.expect(response.data).to.be.an('object');","});","","pm.test(\"Response contains all keys\", function () {"," pm.expect(response.data.hello).to.be.a('string');"," pm.expect(response.data.hello).to.be.eql('Hello World');"," pm.expect(response.data.bye).to.be.a('string');"," pm.expect(response.data.bye).to.be.eql('Goodbye');"," pm.expect(response.data.happy).to.be.eql(2);","});"],"type":"text/javascript"}}],"id":"a836cb2a-8c9e-4b63-8d4c-79f36573993a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"data\": {\r\n\t\t\"hello\": \"Hello World\",\r\n \"bye\": \"Goodbye\",\r\n \"happy\": 2\r\n\t}\r\n}"},"url":"{{base_url}}/v1/translations/:locale/:filename","description":"⚠️ This endpoint is deprecated and may be removed in future versions of Exivity.
\n","urlObject":{"path":["v1","translations",":locale",":filename"],"host":["{{base_url}}"],"query":[],"variable":[{"description":{"content":"ISO 639-1 two letter code representation of names of language
\n","type":"text/plain"},"type":"string","value":"en","key":"locale"},{"type":"string","value":"works","key":"filename"}]}},"response":[],"_postman_id":"a836cb2a-8c9e-4b63-8d4c-79f36573993a"}],"id":"8c4e1311-97c8-48de-ae38-487ecb30d0a5","description":"⚠️ The translations feature is deprecated and not used anymore in new releases. The GUI is now available in several languages (beta feature). We may add similar functionality in the future, to allow editing some terminology used in the GUI.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a299c6f4-104c-4e40-b6b9-004db358458d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0a6d1cae-d3e1-429a-ac47-430fa477eaca","type":"text/javascript","exec":[""]}}],"_postman_id":"8c4e1311-97c8-48de-ae38-487ecb30d0a5"},{"name":"/environments","item":[{"name":"Retrieve a list of environments","event":[{"listen":"test","script":{"id":"67b49a6a-8210-4e29-9b85-481402f67edf","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":"984ed2d3-35cc-4362-928a-22968dd1754e","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":"a4671a36-1981-4ba5-ad14-43b5a4a77fb4","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}}/v1/environments?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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.
You can't delete the default environment.
\nOn success, a HTTP 204 No Content success status response will be returned.
Exivity documentation: https://docs.exivity.com/data-pipelines/transform/language/environment
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"53486121-304d-4d9f-9c02-fd36ed193b01","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f556d843-8a52-4244-acba-d3764d8bb00c","type":"text/javascript","exec":[""]}}],"_postman_id":"f37ee782-e53d-4dc7-a94d-454f255e3d00"},{"name":"/variables","item":[{"name":"Retrieve a list of variables","event":[{"listen":"test","script":{"id":"67b49a6a-8210-4e29-9b85-481402f67edf","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":"f48e3ac2-363b-4936-9249-25ee5630a1fd","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}}/v1/variables?page[limit]&page[offset]&sort&filter[attribute]&include=","urlObject":{"path":["v1","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":"Optionally 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: variables.
Global Variables enable users to configure Exivity system-wide variables which can be used in any Extractor or Transformer script.
\nExivity documentation: https://docs.exivity.com/architecture%20concepts/glossary/#environment
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"53486121-304d-4d9f-9c02-fd36ed193b01","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f556d843-8a52-4244-acba-d3764d8bb00c","type":"text/javascript","exec":[""]}}],"_postman_id":"74fec5b3-e74a-4ce0-9412-26b2d04bec17"},{"name":"/failed-jobs","item":[{"name":"Get all failed jobs","id":"3b18876f-55f1-430e-97d3-2343b306b80d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/v1/failed-jobs","urlObject":{"path":["v1","failed-jobs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b18876f-55f1-430e-97d3-2343b306b80d"}],"id":"d18fd391-6b33-4905-9ed5-d75d155892bc","auth":{"type":"noauth","isInherited":false},"_postman_id":"d18fd391-6b33-4905-9ed5-d75d155892bc","description":""}],"id":"973e5c9a-8d8b-4f08-bb2a-d554819bd23e","auth":{"type":"noauth","isInherited":false},"_postman_id":"973e5c9a-8d8b-4f08-bb2a-d554819bd23e","description":""}],"event":[{"listen":"prerequest","script":{"id":"3e5c01f8-b272-486a-ad6c-8c4840a95109","type":"text/javascript","exec":["console.log('');","console.log('********************* ' + pm.info.requestName + '(v1) *********************');","","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 are set"," 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\") + '/v1/auth/token',"," 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.token);"," console.log('SET token: ' + pm.environment.get(\"token\"));"," pm.environment.set(\"user_id\", json.user.id);"," console.log('SET user_id: ' + pm.environment.get(\"user_id\"));"," return pm.environment.get(\"token\");"," });"," };",""," api.requireReport = function () {"," console.log('requireReport()');",""," // Check if Report ID is set"," if (pm.environment.get(\"report_id\") && pm.environment.get(\"report_id\") !== 'undefined') {"," console.log('GET report_id: ' + pm.environment.get(\"report_id\"));"," return pm.environment.get(\"report_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"," return api.asyncRequest({"," // Create a new report"," url: pm.variables.get(\"base_url\") + '/v1/reports',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"data\": {"," \"type\": \"report\","," \"attributes\": {"," \"name\": \"Test report - \" + Math.floor(Math.random() * 1000),"," \"dset\": pm.variables.get(\"dset_id\"),"," \"lvl1_key_col\": \"Country\","," \"lvl1_name_col\": \"Country\","," \"lvl1_label\": \"Country\","," \"lvl2_key_col\": \"Reseller\","," \"lvl2_name_col\": \"Reseller\","," \"lvl3_label\": \"Reseller\""," }"," }"," })"," }"," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 201)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"report_id\", json.data.id);"," console.log('SET report_id: ' + pm.environment.get(\"report_id\"));"," return pm.environment.get(\"report_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 ID"," if (!pm.environment.get(\"report_id\")) {"," throw new Error('Report ID not set - need to create Account');"," }",""," return api.asyncRequest({"," // Create a new account"," url: pm.variables.get(\"base_url\") + '/v1/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\": {"," \"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(\"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\") + '/v1/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\": \"charge\""," },"," \"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\") + '/v1/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\") + '/v1/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\": \"month\","," \"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\") + '/v1/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\") + '/v1/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\","," \"tier_aggregation_level\": \"1\""," },"," \"relationships\": {"," \"service\": {"," \"data\": {"," \"type\": \"service\","," \"id\": pm.variables.get(\"service_id\")"," }"," }"," }"," }"," })"," }"," }).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\") + '/v1/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\") + '/v1/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\","," \"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\") + '/v1/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\") + '/v1/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\") + '/v1/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\") + '/v1/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\") + '/v1/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\");"," });"," };",""," api.requireExtractor = function () {"," console.log('requireExtractor()');",""," // Check if Report ID is set"," if (pm.environment.get(\"extractor_name\") && pm.environment.get(\"extractor_name\") !== 'undefined') {"," console.log('GET extractor_name: ' + pm.environment.get(\"extractor_name\"));"," return pm.environment.get(\"extractor_name\");"," }","",""," // Create extractor"," return api.asyncRequest({"," // Create a new extractor"," url: pm.variables.get(\"base_url\") + '/v1/extractors',"," method: 'POST',"," header: {"," 'Accept': 'application/json',"," 'Content-Type': 'application/json',"," 'Authorization': 'Bearer ' + pm.variables.get(\"token\")"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," \"name\": \"Test extractor - \" + Math.floor(Math.random() * 1000),"," \"contents\": \"print Hello\\nvar key1 = value1\\npublic var key2 = value2\\npublic encrypt var key3 = 0\""," })"," }",""," }).then(function (response) {"," if (!pm.expect(response).to.have.property('code', 200)) {"," throw new Error(response);"," }"," json = response.json();"," pm.environment.set(\"extractor_name\", json.name);"," console.log('SET extractor_name: ' + pm.environment.get(\"extractor_name\"));"," return pm.environment.get(\"extractor_name\");"," });"," };",""," // Export everything"," return api;","};","","pm.globals.set('exivity', helpers.toString());"]}},{"listen":"test","script":{"id":"6d5a6a6f-e18b-4209-ba57-7c0fe6e7bd39","type":"text/javascript","exec":[""]}}],"variable":[{"key":"component","value":"use"}]}