{"items":[{"type":"link","label":"Interu API","link":"/reference/api","routeSlug":"/reference/api","content":{"contentType":"overview","meta":{"name":"Interu API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api.json","url":"/_bundle/reference/api.json?download"},{"kind":"download","label":"api.yaml","url":"/_bundle/reference/api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT","variables":{}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Interu API (v2_79)","showPageActions":true}],"sectionId":"/"}]}]}},{"type":"separator","label":"Assessment","content":null},{"type":"group","label":"Validation","link":"/reference/api/validation","routeSlug":"/reference/api/validation","items":[{"label":"Get Validation Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/validation/validationservice_post","routeSlug":"/reference/api/validation/validationservice_post","metadata":{"seo":{"title":"Get Validation Status","description":"Retrieve validation status for given records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ValidationService_post","name":"Get Validation Status","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1validation~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Validation Status","badges":[{"name":"Proposed Endpoint","color":"#f0c500"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve validation status for given records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1validation~1status/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1validation~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Assessment.ValidationRequest"}},"schemaId":"components/schemas/Assessment.ValidationRequest","pointer":"/paths/~1organisations~1{orgId}~1validation~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/validation/status","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Assessment.ValidationRequest"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/validation/status","href":"validation/validationservice_post","openApiOperationId":"ValidationService_post","summary":"Get Validation Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Assessment.ValidationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Assessment.ValidationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Assessment.ValidationResult"}},"schemaId":"components/schemas/Assessment.ValidationResult","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1validation~1status/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Assessment.ValidationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Assessment.ValidationResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/validation/validationservice_post"}],"panels":[]}]},"badges":[{"name":"Proposed Endpoint","color":"#f0c500"}],"httpPath":"/organisations/{orgId}/validation/status"}],"content":{"contentType":"group","meta":{"name":"Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validation","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Validation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/validation/status","summary":"Get Validation Status","prefix":{"name":"post","color":"post"},"badges":[{"name":"Proposed Endpoint","color":"#f0c500"}],"link":"/validation/validationservice_post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Common","content":null},{"type":"group","label":"Base Units","link":"/reference/api/base-units","routeSlug":"/reference/api/base-units","items":[{"label":"Retrieve BaseUnit List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/base-units/baseunits_list","routeSlug":"/reference/api/base-units/baseunits_list","metadata":{"seo":{"title":"Retrieve BaseUnit List","description":"Retrieve BaseUnit List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BaseUnits_list","name":"Retrieve BaseUnit List","isWebhook":false,"pointer":"/paths/~1common~1base-units/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve BaseUnit List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"symbol","in":"query","explode":false,"schemaId":"schema_0"},{"name":"type","in":"query","explode":false,"schemaId":"schema_3"}],"pointer":"/paths/~1common~1base-units/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/base-units","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"symbol","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"type","in":"query","required":false,"schemaId":"components/schemas/Common.BaseUnitType","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/common/base-units","href":"base-units/baseunits_list","openApiOperationId":"BaseUnits_list","summary":"Retrieve BaseUnit List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1base-units/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/base-units/baseunits_list"}],"panels":[]}]},"httpPath":"/common/base-units"},{"label":"Retrieve BaseUnit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/base-units/baseunits_read","routeSlug":"/reference/api/base-units/baseunits_read","metadata":{"seo":{"title":"Retrieve BaseUnit","description":"Retrieve BaseUnit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BaseUnits_read","name":"Retrieve BaseUnit","isWebhook":false,"pointer":"/paths/~1common~1base-units~1{unitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve BaseUnit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"unitId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1common~1base-units~1{unitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/base-units/{unitId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"unitId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/common/base-units/{unitId}","href":"base-units/baseunits_read","openApiOperationId":"BaseUnits_read","summary":"Retrieve BaseUnit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.BaseUnit"}},"schemaId":"components/schemas/Common.BaseUnit"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1base-units~1{unitId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Common.BaseUnit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.BaseUnit"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/base-units/baseunits_read"}],"panels":[]}]},"httpPath":"/common/base-units/{unitId}"}],"content":{"contentType":"group","meta":{"name":"Base Units"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Base Units","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Base Units."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/common/base-units","summary":"Retrieve BaseUnit List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/base-units/baseunits_list","deprecated":false},{"title":"/common/base-units/{unitId}","summary":"Retrieve BaseUnit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/base-units/baseunits_read","deprecated":false}]}]}]}]}},{"type":"group","label":"Country List","link":"/reference/api/country-list","routeSlug":"/reference/api/country-list","items":[{"label":"Retrieve Countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/country-list/countries_list","routeSlug":"/reference/api/country-list/countries_list","metadata":{"seo":{"title":"Retrieve Countries","description":"Retrieve Countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Countries_list","name":"Retrieve Countries","isWebhook":false,"pointer":"/paths/~1common~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isEuMember","in":"query","explode":false,"schemaId":"schema_5","description":"Restrict the returned list to EU only country codes."}],"pointer":"/paths/~1common~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/countries","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[],"query":[{"name":"isEuMember","in":"query","required":false,"schemaId":"schema_5","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/common/countries","href":"country-list/countries_list","openApiOperationId":"Countries_list","summary":"Retrieve Countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/country-list/countries_list"}],"panels":[]}]},"httpPath":"/common/countries"}],"content":{"contentType":"group","meta":{"name":"Country List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Country List","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Country List."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/common/countries","summary":"Retrieve Countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/country-list/countries_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Standards","link":"/reference/api/standards","routeSlug":"/reference/api/standards","items":[{"label":"Retrieve Standard List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/standards/standards_list","routeSlug":"/reference/api/standards/standards_list","metadata":{"seo":{"title":"Retrieve Standard List","description":"Retrieve Standard List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Standards_list","name":"Retrieve Standard List","isWebhook":false,"pointer":"/paths/~1common~1standards/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Standard List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1common~1standards/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/standards","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/common/standards","href":"standards/standards_list","openApiOperationId":"Standards_list","summary":"Retrieve Standard List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1standards/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standards/standards_list"}],"panels":[]}]},"httpPath":"/common/standards"},{"label":"Retrieve Standard","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/standards/standards_read","routeSlug":"/reference/api/standards/standards_read","metadata":{"seo":{"title":"Retrieve Standard","description":"Retrieve Standard"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Standards_read","name":"Retrieve Standard","isWebhook":false,"pointer":"/paths/~1common~1standards~1{standardId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Standard","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"standardId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1common~1standards~1{standardId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/standards/{standardId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"standardId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/common/standards/{standardId}","href":"standards/standards_read","openApiOperationId":"Standards_read","summary":"Retrieve Standard"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.Standard"}},"schemaId":"components/schemas/Common.Standard"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1standards~1{standardId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Common.Standard","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.Standard"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standards/standards_read"}],"panels":[]}]},"httpPath":"/common/standards/{standardId}"},{"label":"Retrieve StandardType List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/standards/standardtypes_list","routeSlug":"/reference/api/standards/standardtypes_list","metadata":{"seo":{"title":"Retrieve StandardType List","description":"Retrieve StandardType List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StandardTypes_list","name":"Retrieve StandardType List","isWebhook":false,"pointer":"/paths/~1common~1standards~1{standardId}~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve StandardType List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"standardId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1common~1standards~1{standardId}~1types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7","description":"The status of the record."}],"pointer":"/paths/~1common~1standards~1{standardId}~1types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/standards/{standardId}/types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"standardId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/common/standards/{standardId}/types","href":"standards/standardtypes_list","openApiOperationId":"StandardTypes_list","summary":"Retrieve StandardType List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1standards~1{standardId}~1types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standards/standardtypes_list"}],"panels":[]}]},"httpPath":"/common/standards/{standardId}/types"},{"label":"Retrieve StandardType","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/standards/standardtypes_read","routeSlug":"/reference/api/standards/standardtypes_read","metadata":{"seo":{"title":"Retrieve StandardType","description":"Retrieve StandardType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StandardTypes_read","name":"Retrieve StandardType","isWebhook":false,"pointer":"/paths/~1common~1standards~1{standardId}~1types~1{standardTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve StandardType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"standardTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"standardId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1common~1standards~1{standardId}~1types~1{standardTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/common/standards/{standardId}/types/{standardTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"standardTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"standardId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/common/standards/{standardId}/types/{standardTypeId}","href":"standards/standardtypes_read","openApiOperationId":"StandardTypes_read","summary":"Retrieve StandardType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.StandardType"}},"schemaId":"components/schemas/Common.StandardType"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1common~1standards~1{standardId}~1types~1{standardTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Common.StandardType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Common.StandardType"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/standards/standardtypes_read"}],"panels":[]}]},"httpPath":"/common/standards/{standardId}/types/{standardTypeId}"}],"content":{"contentType":"group","meta":{"name":"Standards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Standards","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Standards."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/common/standards","summary":"Retrieve Standard List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standards/standards_list","deprecated":false},{"title":"/common/standards/{standardId}","summary":"Retrieve Standard","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standards/standards_read","deprecated":false},{"title":"/common/standards/{standardId}/types","summary":"Retrieve StandardType List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standards/standardtypes_list","deprecated":false},{"title":"/common/standards/{standardId}/types/{standardTypeId}","summary":"Retrieve StandardType","prefix":{"name":"get","color":"get"},"badges":[],"link":"/standards/standardtypes_read","deprecated":false}]}]}]}]}},{"type":"separator","label":"Config","content":null},{"type":"group","label":"Document Types","link":"/reference/api/document-types","routeSlug":"/reference/api/document-types","items":[{"label":"Create DocumentType","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/document-types/documenttypes_post","routeSlug":"/reference/api/document-types/documenttypes_post","metadata":{"seo":{"title":"Create DocumentType","description":"Create DocumentType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentTypes_post","name":"Create DocumentType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1document-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create DocumentType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeCreate"}},"schemaId":"components/schemas/Config.DocumentTypeCreate","pointer":"/paths/~1organisations~1{orgId}~1document-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/document-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/document-types","href":"document-types/documenttypes_post","openApiOperationId":"DocumentTypes_post","summary":"Create DocumentType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.DocumentTypeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}},"schemaId":"components/schemas/Config.DocumentType","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Config.DocumentType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-types/documenttypes_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/document-types"},{"label":"Retrieve DocumentType List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/document-types/documenttypes_list","routeSlug":"/reference/api/document-types/documenttypes_list","metadata":{"seo":{"title":"Retrieve DocumentType List","description":"Retrieve DocumentType List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentTypes_list","name":"Retrieve DocumentType List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1document-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DocumentType List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/document-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/document-types","href":"document-types/documenttypes_list","openApiOperationId":"DocumentTypes_list","summary":"Retrieve DocumentType List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1document-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-types/documenttypes_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/document-types"},{"label":"Retrieve DocumentType","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/document-types/documenttypes_read","routeSlug":"/reference/api/document-types/documenttypes_read","metadata":{"seo":{"title":"Retrieve DocumentType","description":"Retrieve DocumentType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentTypes_read","name":"Retrieve DocumentType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DocumentType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/document-types/{documentTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/document-types/{documentTypeId}","href":"document-types/documenttypes_read","openApiOperationId":"DocumentTypes_read","summary":"Retrieve DocumentType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}},"schemaId":"components/schemas/Config.DocumentType"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.DocumentType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-types/documenttypes_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/document-types/{documentTypeId}"},{"label":"Update DocumentType","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/document-types/documenttypes_update","routeSlug":"/reference/api/document-types/documenttypes_update","metadata":{"seo":{"title":"Update DocumentType","description":"Update DocumentType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentTypes_update","name":"Update DocumentType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update DocumentType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeUpdate"}},"schemaId":"components/schemas/Config.DocumentTypeUpdate","pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/document-types/{documentTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/document-types/{documentTypeId}","href":"document-types/documenttypes_update","openApiOperationId":"DocumentTypes_update","summary":"Update DocumentType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.DocumentTypeUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.DocumentTypeUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}},"schemaId":"components/schemas/Config.DocumentType"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.DocumentType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.DocumentType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-types/documenttypes_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/document-types/{documentTypeId}"},{"label":"Delete DocumentType","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/document-types/documenttypes_delete","routeSlug":"/reference/api/document-types/documenttypes_delete","metadata":{"seo":{"title":"Delete DocumentType","description":"Delete DocumentType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentTypes_delete","name":"Delete DocumentType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete DocumentType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/document-types/{documentTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/document-types/{documentTypeId}","href":"document-types/documenttypes_delete","openApiOperationId":"DocumentTypes_delete","summary":"Delete DocumentType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1document-types~1{documentTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/document-types/documenttypes_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/document-types/{documentTypeId}"}],"content":{"contentType":"group","meta":{"name":"Document Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Types","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Document Types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/document-types","summary":"Create DocumentType","prefix":{"name":"post","color":"post"},"badges":[],"link":"/document-types/documenttypes_post","deprecated":false},{"title":"/organisations/{orgId}/document-types","summary":"Retrieve DocumentType List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-types/documenttypes_list","deprecated":false},{"title":"/organisations/{orgId}/document-types/{documentTypeId}","summary":"Retrieve DocumentType","prefix":{"name":"get","color":"get"},"badges":[],"link":"/document-types/documenttypes_read","deprecated":false},{"title":"/organisations/{orgId}/document-types/{documentTypeId}","summary":"Update DocumentType","prefix":{"name":"put","color":"put"},"badges":[],"link":"/document-types/documenttypes_update","deprecated":false},{"title":"/organisations/{orgId}/document-types/{documentTypeId}","summary":"Delete DocumentType","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/document-types/documenttypes_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Location Types","link":"/reference/api/location-types","routeSlug":"/reference/api/location-types","items":[{"label":"Create LocationType","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/location-types/locationtypes_post","routeSlug":"/reference/api/location-types/locationtypes_post","metadata":{"seo":{"title":"Create LocationType","description":"Create LocationType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationTypes_post","name":"Create LocationType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create LocationType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeCreate"}},"schemaId":"components/schemas/Config.LocationTypeCreate","pointer":"/paths/~1organisations~1{orgId}~1location-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/location-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/location-types","href":"location-types/locationtypes_post","openApiOperationId":"LocationTypes_post","summary":"Create LocationType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.LocationTypeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}},"schemaId":"components/schemas/Config.LocationType","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Config.LocationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-types/locationtypes_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-types"},{"label":"Retrieve LocationType List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/location-types/locationtypes_list","routeSlug":"/reference/api/location-types/locationtypes_list","metadata":{"seo":{"title":"Retrieve LocationType List","description":"Retrieve LocationType List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationTypes_list","name":"Retrieve LocationType List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve LocationType List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","explode":false,"schemaId":"schema_0","description":"Specific location type to query for."},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7","description":"The record state to query for."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/location-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"type","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/location-types","href":"location-types/locationtypes_list","openApiOperationId":"LocationTypes_list","summary":"Retrieve LocationType List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-types/locationtypes_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-types"},{"label":"Retrieve LocationType","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/location-types/locationtypes_read","routeSlug":"/reference/api/location-types/locationtypes_read","metadata":{"seo":{"title":"Retrieve LocationType","description":"Retrieve LocationType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationTypes_read","name":"Retrieve LocationType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve LocationType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/location-types/{locTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/location-types/{locTypeId}","href":"location-types/locationtypes_read","openApiOperationId":"LocationTypes_read","summary":"Retrieve LocationType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}},"schemaId":"components/schemas/Config.LocationType"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.LocationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-types/locationtypes_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-types/{locTypeId}"},{"label":"Update LocationType","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/location-types/locationtypes_update","routeSlug":"/reference/api/location-types/locationtypes_update","metadata":{"seo":{"title":"Update LocationType","description":"Update LocationType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationTypes_update","name":"Update LocationType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update LocationType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeUpdate"}},"schemaId":"components/schemas/Config.LocationTypeUpdate","pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/location-types/{locTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/location-types/{locTypeId}","href":"location-types/locationtypes_update","openApiOperationId":"LocationTypes_update","summary":"Update LocationType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.LocationTypeUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.LocationTypeUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}},"schemaId":"components/schemas/Config.LocationType"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.LocationType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.LocationType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-types/locationtypes_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-types/{locTypeId}"},{"label":"Delete LocationType","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/location-types/locationtypes_delete","routeSlug":"/reference/api/location-types/locationtypes_delete","metadata":{"seo":{"title":"Delete LocationType","description":"Delete LocationType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationTypes_delete","name":"Delete LocationType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete LocationType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/location-types/{locTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/location-types/{locTypeId}","href":"location-types/locationtypes_delete","openApiOperationId":"LocationTypes_delete","summary":"Delete LocationType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-types~1{locTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/location-types/locationtypes_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-types/{locTypeId}"}],"content":{"contentType":"group","meta":{"name":"Location Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Types","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Location Types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/location-types","summary":"Create LocationType","prefix":{"name":"post","color":"post"},"badges":[],"link":"/location-types/locationtypes_post","deprecated":false},{"title":"/organisations/{orgId}/location-types","summary":"Retrieve LocationType List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-types/locationtypes_list","deprecated":false},{"title":"/organisations/{orgId}/location-types/{locTypeId}","summary":"Retrieve LocationType","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-types/locationtypes_read","deprecated":false},{"title":"/organisations/{orgId}/location-types/{locTypeId}","summary":"Update LocationType","prefix":{"name":"put","color":"put"},"badges":[],"link":"/location-types/locationtypes_update","deprecated":false},{"title":"/organisations/{orgId}/location-types/{locTypeId}","summary":"Delete LocationType","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/location-types/locationtypes_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Process Types","link":"/reference/api/process-types","routeSlug":"/reference/api/process-types","items":[{"label":"Create ProcessType","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-types/processtypes_post","routeSlug":"/reference/api/process-types/processtypes_post","metadata":{"seo":{"title":"Create ProcessType","description":"Create ProcessType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessTypes_post","name":"Create ProcessType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1process-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ProcessType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeCreate"}},"schemaId":"components/schemas/Config.ProcessTypeCreate","pointer":"/paths/~1organisations~1{orgId}~1process-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/process-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/process-types","href":"process-types/processtypes_post","openApiOperationId":"ProcessTypes_post","summary":"Create ProcessType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.ProcessTypeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}},"schemaId":"components/schemas/Config.ProcessType","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Config.ProcessType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-types/processtypes_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/process-types"},{"label":"Retrieve ProcessType List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-types/processtypes_list","routeSlug":"/reference/api/process-types/processtypes_list","metadata":{"seo":{"title":"Retrieve ProcessType List","description":"Retrieve ProcessType List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessTypes_list","name":"Retrieve ProcessType List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1process-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessType List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/process-types","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/process-types","href":"process-types/processtypes_list","openApiOperationId":"ProcessTypes_list","summary":"Retrieve ProcessType List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1process-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-types/processtypes_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/process-types"},{"label":"Retrieve ProcessType","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-types/processtypes_read","routeSlug":"/reference/api/process-types/processtypes_read","metadata":{"seo":{"title":"Retrieve ProcessType","description":"Retrieve ProcessType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessTypes_read","name":"Retrieve ProcessType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/process-types/{processTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/process-types/{processTypeId}","href":"process-types/processtypes_read","openApiOperationId":"ProcessTypes_read","summary":"Retrieve ProcessType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}},"schemaId":"components/schemas/Config.ProcessType"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.ProcessType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-types/processtypes_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/process-types/{processTypeId}"},{"label":"Update ProcessType","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-types/processtypes_update","routeSlug":"/reference/api/process-types/processtypes_update","metadata":{"seo":{"title":"Update ProcessType","description":"Update ProcessType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessTypes_update","name":"Update ProcessType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update ProcessType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeUpdate"}},"schemaId":"components/schemas/Config.ProcessTypeUpdate","pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/process-types/{processTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/process-types/{processTypeId}","href":"process-types/processtypes_update","openApiOperationId":"ProcessTypes_update","summary":"Update ProcessType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Config.ProcessTypeUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Config.ProcessTypeUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}},"schemaId":"components/schemas/Config.ProcessType"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Config.ProcessType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Config.ProcessType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-types/processtypes_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/process-types/{processTypeId}"},{"label":"Delete ProcessType","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-types/processtypes_delete","routeSlug":"/reference/api/process-types/processtypes_delete","metadata":{"seo":{"title":"Delete ProcessType","description":"Delete ProcessType"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessTypes_delete","name":"Delete ProcessType","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ProcessType","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processTypeId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/process-types/{processTypeId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processTypeId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/process-types/{processTypeId}","href":"process-types/processtypes_delete","openApiOperationId":"ProcessTypes_delete","summary":"Delete ProcessType"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1process-types~1{processTypeId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-types/processtypes_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/process-types/{processTypeId}"}],"content":{"contentType":"group","meta":{"name":"Process Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process Types","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Process Types."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/process-types","summary":"Create ProcessType","prefix":{"name":"post","color":"post"},"badges":[],"link":"/process-types/processtypes_post","deprecated":false},{"title":"/organisations/{orgId}/process-types","summary":"Retrieve ProcessType List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/process-types/processtypes_list","deprecated":false},{"title":"/organisations/{orgId}/process-types/{processTypeId}","summary":"Retrieve ProcessType","prefix":{"name":"get","color":"get"},"badges":[],"link":"/process-types/processtypes_read","deprecated":false},{"title":"/organisations/{orgId}/process-types/{processTypeId}","summary":"Update ProcessType","prefix":{"name":"put","color":"put"},"badges":[],"link":"/process-types/processtypes_update","deprecated":false},{"title":"/organisations/{orgId}/process-types/{processTypeId}","summary":"Delete ProcessType","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/process-types/processtypes_delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Evidence","content":null},{"type":"group","label":"Attachments","link":"/reference/api/attachments","routeSlug":"/reference/api/attachments","items":[{"label":"Create Attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/attachments/attachments_post","routeSlug":"/reference/api/attachments/attachments_post","metadata":{"seo":{"title":"Create Attachment","description":"Create Attachment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Attachments_post","name":"Create Attachment","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment.AttachmentCreate"}},"schemaId":"components/schemas/Attachment.AttachmentCreate","pointer":"/paths/~1organisations~1{orgId}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/attachments","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Attachment.AttachmentCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/attachments","href":"attachments/attachments_post","openApiOperationId":"Attachments_post","summary":"Create Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Attachment.AttachmentCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Attachment.AttachmentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment.Attachment"}},"schemaId":"components/schemas/Attachment.Attachment","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Attachment.Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment.Attachment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/attachments_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/attachments"},{"label":"Retrieve Attachment List ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/attachments/attachments_list","routeSlug":"/reference/api/attachments/attachments_list","metadata":{"seo":{"title":"Retrieve Attachment List ","description":"Retrieve Attachment List "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Attachments_list","name":"Retrieve Attachment List ","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Attachment List ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"attachmentType","in":"query","explode":false,"schemaId":"schema_15","description":"The record type of the attachment record."},{"name":"targetType","in":"query","explode":false,"schemaId":"schema_16","description":"The record type of the target record."},{"name":"targetUri","in":"query","explode":false,"schemaId":"schema_17","description":"The target URI that the attachment is being attached to."},{"name":"attachmentUri","in":"query","explode":false,"schemaId":"schema_17","description":"The URI of the attachment."}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/attachments","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"attachmentType","in":"query","required":false,"schemaId":"components/schemas/Attachment.QueryAttachmentType","explode":false},{"name":"targetType","in":"query","required":false,"schemaId":"components/schemas/Attachment.QueryTargetType","explode":false},{"name":"targetUri","in":"query","required":false,"schemaId":"schema_17","explode":false},{"name":"attachmentUri","in":"query","required":false,"schemaId":"schema_17","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/attachments","href":"attachments/attachments_list","openApiOperationId":"Attachments_list","summary":"Retrieve Attachment List "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/attachments_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/attachments"},{"label":"Retrieve Attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/attachments/attachments_read","routeSlug":"/reference/api/attachments/attachments_read","metadata":{"seo":{"title":"Retrieve Attachment","description":"Retrieve Attachment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Attachments_read","name":"Retrieve Attachment","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachmentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/attachments/{attachmentId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"attachmentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/attachments/{attachmentId}","href":"attachments/attachments_read","openApiOperationId":"Attachments_read","summary":"Retrieve Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment.Attachment"}},"schemaId":"components/schemas/Attachment.Attachment"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Attachment.Attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Attachment.Attachment"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/attachments_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/attachments/{attachmentId}"},{"label":"Delete Attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/attachments/attachments_delete","routeSlug":"/reference/api/attachments/attachments_delete","metadata":{"seo":{"title":"Delete Attachment","description":"Delete Attachment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Attachments_delete","name":"Delete Attachment","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attachmentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/attachments/{attachmentId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"attachmentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/attachments/{attachmentId}","href":"attachments/attachments_delete","openApiOperationId":"Attachments_delete","summary":"Delete Attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1attachments~1{attachmentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/attachments_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/attachments/{attachmentId}"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Attachments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/attachments","summary":"Create Attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/attachments_post","deprecated":false},{"title":"/organisations/{orgId}/attachments","summary":"Retrieve Attachment List ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/attachments_list","deprecated":false},{"title":"/organisations/{orgId}/attachments/{attachmentId}","summary":"Retrieve Attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/attachments_read","deprecated":false},{"title":"/organisations/{orgId}/attachments/{attachmentId}","summary":"Delete Attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/attachments_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents","link":"/reference/api/documents","routeSlug":"/reference/api/documents","items":[{"label":"Create Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_post","routeSlug":"/reference/api/documents/documents_post","metadata":{"seo":{"title":"Create Document","description":"Create a Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_post","name":"Create Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreate"}},"schemaId":"components/schemas/Evidence.DocumentCreate","pointer":"/paths/~1organisations~1{orgId}~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/documents","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/documents","href":"documents/documents_post","openApiOperationId":"Documents_post","summary":"Create Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Evidence.DocumentCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}},"schemaId":"components/schemas/Evidence.Document","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Evidence.Document","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents"},{"label":"Retrieve Document List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_list","routeSlug":"/reference/api/documents/documents_list","metadata":{"seo":{"title":"Retrieve Document List","description":"Retrieve the list of Documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_list","name":"Retrieve Document List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Document List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of Documents"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across document fields."},{"name":"hasContent","in":"query","explode":false,"schemaId":"schema_5"},{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"typeIds","in":"query","explode":false,"schemaId":"schema_6"},{"name":"contentHash","in":"query","explode":false,"schemaId":"schema_0"},{"name":"isPrivate","in":"query","explode":false,"schemaId":"schema_5","description":"Filter documents by whether they are marked private and therefore not shared."},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1documents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/documents","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"hasContent","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"typeIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"contentHash","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"isPrivate","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/documents","href":"documents/documents_list","openApiOperationId":"Documents_list","summary":"Retrieve Document List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents"},{"label":"Retrieve Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_read","routeSlug":"/reference/api/documents/documents_read","metadata":{"seo":{"title":"Retrieve Document","description":"Retrieve an existing Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_read","name":"Retrieve Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an existing Document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/documents/{documentId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/documents/{documentId}","href":"documents/documents_read","openApiOperationId":"Documents_read","summary":"Retrieve Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}},"schemaId":"components/schemas/Evidence.Document"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Evidence.Document","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents/{documentId}"},{"label":"Update Document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_update","routeSlug":"/reference/api/documents/documents_update","metadata":{"seo":{"title":"Update Document","description":"Update the details of an existing Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_update","name":"Update Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of an existing Document"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreateOrUpdate"}},"schemaId":"components/schemas/Evidence.DocumentCreateOrUpdate","pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/documents/{documentId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreateOrUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/documents/{documentId}","href":"documents/documents_update","openApiOperationId":"Documents_update","summary":"Update Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Evidence.DocumentCreateOrUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Evidence.DocumentCreateOrUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}},"schemaId":"components/schemas/Evidence.Document"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Evidence.Document","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Evidence.Document"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents/{documentId}"},{"label":"Delete Document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_delete","routeSlug":"/reference/api/documents/documents_delete","metadata":{"seo":{"title":"Delete Document","description":"Delete Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_delete","name":"Delete Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/documents/{documentId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/documents/{documentId}","href":"documents/documents_delete","openApiOperationId":"Documents_delete","summary":"Delete Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents/{documentId}"},{"label":"Upload Document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_uploadcontent","routeSlug":"/reference/api/documents/documents_uploadcontent","metadata":{"seo":{"title":"Upload Document","description":"Upload the contents of a file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_uploadContent","name":"Upload Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload the contents of a file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_20"}},"schemaId":"schema_20","pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/documents/{documentId}/content","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/octet-stream":{"schemaId":"schema_20"}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/organisations/{orgId}/documents/{documentId}/content","href":"documents/documents_uploadcontent","openApiOperationId":"Documents_uploadContent","summary":"Upload Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"schema_20","mediaTypes":["application/octet-stream"],"mediaTypeSchemas":{"application/octet-stream":{"schemaId":"schema_20"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded."},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_uploadcontent"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents/{documentId}/content"},{"label":"Download Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/documents/documents_downloadcontent","routeSlug":"/reference/api/documents/documents_downloadcontent","metadata":{"seo":{"title":"Download Document","description":"Download the contents of a file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Documents_downloadContent","name":"Download Document","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download the contents of a file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"documentId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/documents/{documentId}/content","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"documentId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/organisations/{orgId}/documents/{documentId}/content","href":"documents/documents_downloadcontent","openApiOperationId":"Documents_downloadContent","summary":"Download Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_20"}},"schemaId":"schema_20"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1documents~1{documentId}~1content/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_20"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/documents_downloadcontent"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/documents/{documentId}/content"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Documents."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/documents","summary":"Create Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/documents_post","deprecated":false},{"title":"/organisations/{orgId}/documents","summary":"Retrieve Document List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/documents_list","deprecated":false},{"title":"/organisations/{orgId}/documents/{documentId}","summary":"Retrieve Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/documents_read","deprecated":false},{"title":"/organisations/{orgId}/documents/{documentId}","summary":"Update Document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/documents/documents_update","deprecated":false},{"title":"/organisations/{orgId}/documents/{documentId}","summary":"Delete Document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/documents/documents_delete","deprecated":false},{"title":"/organisations/{orgId}/documents/{documentId}/content","summary":"Upload Document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/documents/documents_uploadcontent","deprecated":false},{"title":"/organisations/{orgId}/documents/{documentId}/content","summary":"Download Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/documents_downloadcontent","deprecated":false}]}]}]}]}},{"type":"separator","label":"Integration","content":null},{"type":"group","label":"EUDR","link":"/reference/api/eudr","routeSlug":"/reference/api/eudr","items":[{"label":"Create Credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/credentials_create","routeSlug":"/reference/api/eudr/credentials_create","metadata":{"seo":{"title":"Create Credential","description":"Creates an Traces NT Credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credentials_create","name":"Create Credential","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an Traces NT Credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreate"}},"schemaId":"components/schemas/Integrations.Eudr.CredentialCreate","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/credentials","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/credentials","href":"eudr/credentials_create","openApiOperationId":"Credentials_create","summary":"Create Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.CredentialCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}},"schemaId":"components/schemas/Integrations.Eudr.Credential","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Integrations.Eudr.Credential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/credentials_create"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/credentials"},{"label":"Retrieve Credential List ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/credentials_list","routeSlug":"/reference/api/eudr/credentials_list","metadata":{"seo":{"title":"Retrieve Credential List ","description":"Gets the list of Traces NT Credentials for an organisation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credentials_list","name":"Retrieve Credential List ","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Credential List ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of Traces NT Credentials for an organisation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/credentials","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/credentials","href":"eudr/credentials_list","openApiOperationId":"Credentials_list","summary":"Retrieve Credential List "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/credentials_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/credentials"},{"label":"Retrieve Credential","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/credentials_read","routeSlug":"/reference/api/eudr/credentials_read","metadata":{"seo":{"title":"Retrieve Credential","description":"Retrieves an existing Traces NT Credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credentials_read","name":"Retrieve Credential","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing Traces NT Credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credentialsId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"credentialsId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","href":"eudr/credentials_read","openApiOperationId":"Credentials_read","summary":"Retrieve Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}},"schemaId":"components/schemas/Integrations.Eudr.Credential"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.Credential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/credentials_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}"},{"label":"Update Credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/credentials_update","routeSlug":"/reference/api/eudr/credentials_update","metadata":{"seo":{"title":"Update Credential","description":"Updates an existing Traces NT Credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credentials_update","name":"Update Credential","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing Traces NT Credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credentialsId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate"}},"schemaId":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"credentialsId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","href":"eudr/credentials_update","openApiOperationId":"Credentials_update","summary":"Update Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}},"schemaId":"components/schemas/Integrations.Eudr.Credential"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.Credential","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.Credential"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/credentials_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}"},{"label":"Delete Credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/credentials_delete","routeSlug":"/reference/api/eudr/credentials_delete","metadata":{"seo":{"title":"Delete Credential","description":"Deletes a Traces NT Credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Credentials_delete","name":"Delete Credential","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a Traces NT Credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credentialsId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"credentialsId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","href":"eudr/credentials_delete","openApiOperationId":"Credentials_delete","summary":"Delete Credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1credentials~1{credentialsId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/credentials_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}"},{"label":"Create DDS Reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferences_create","routeSlug":"/reference/api/eudr/ddsreferences_create","metadata":{"seo":{"title":"Create DDS Reference","description":"Creates an EUDR DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferences_create","name":"Create DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an EUDR DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CreateDDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.CreateDDSReference","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CreateDDSReference"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references","href":"eudr/ddsreferences_create","openApiOperationId":"DDSReferences_create","summary":"Create DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.CreateDDSReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.CreateDDSReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReference","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Integrations.Eudr.DDSReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferences_create"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references"},{"label":"Retrieve DDS Reference List ","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferences_list","routeSlug":"/reference/api/eudr/ddsreferences_list","metadata":{"seo":{"title":"Retrieve DDS Reference List ","description":"Gets the list of DDS References."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferences_list","name":"Retrieve DDS Reference List ","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DDS Reference List ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of DDS References."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"internalReference","in":"query","explode":false,"schemaId":"schema_0","description":"The internal reference number for the DDS Reference."},{"name":"status","in":"query","explode":false,"schemaId":"schema_22","description":"Get the DDS references with the provided status."},{"name":"sourceResourceType","in":"query","explode":false,"schemaId":"schema_23","description":"This is the resource type of the source.","required":true},{"name":"buyers","in":"query","explode":false,"schemaId":"schema_6","description":"Filter by buyer URIs."},{"name":"suppliers","in":"query","explode":false,"schemaId":"schema_6","description":"Filter by supplier URIs."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/references","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"internalReference","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/Integrations.Eudr.DDSStatus","explode":false},{"name":"sourceResourceType","in":"query","required":true,"schemaId":"components/schemas/Integrations.Eudr.SourceResourceType","explode":false},{"name":"buyers","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"suppliers","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references","href":"eudr/ddsreferences_list","openApiOperationId":"DDSReferences_list","summary":"Retrieve DDS Reference List "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferences_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references"},{"label":"Find DDS Reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/findddsreferences_find","routeSlug":"/reference/api/eudr/findddsreferences_find","metadata":{"seo":{"title":"Find DDS Reference","description":"Finds DDS Reference for provided record ids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FindDDSReferences_find","name":"Find DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1find/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Finds DDS Reference for provided record ids."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1find/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1find/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.FindDDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.FindDDSReference","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1find/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/find","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.FindDDSReference"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/find","href":"eudr/findddsreferences_find","openApiOperationId":"FindDDSReferences_find","summary":"Find DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.FindDDSReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.FindDDSReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1find/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/findddsreferences_find"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/find"},{"label":"Resolve DDS Reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/resolveddsreferences_resolve","routeSlug":"/reference/api/eudr/resolveddsreferences_resolve","metadata":{"seo":{"title":"Resolve DDS Reference","description":"Resolves DDS References for provided record ids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ResolveDDSReferences_resolve","name":"Resolve DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1resolve/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resolve DDS Reference","badges":[{"name":"Work In Progress","color":"#0068ff"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resolves DDS References for provided record ids."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1resolve/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1resolve/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.ResolveDDSRequest"}},"schemaId":"components/schemas/Integrations.Eudr.ResolveDDSRequest","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1resolve/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/resolve","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.ResolveDDSRequest"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/resolve","href":"eudr/resolveddsreferences_resolve","openApiOperationId":"ResolveDDSReferences_resolve","summary":"Resolve DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.ResolveDDSRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.ResolveDDSRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1resolve/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/resolveddsreferences_resolve"}],"panels":[]}]},"badges":[{"name":"Work In Progress","color":"#0068ff"}],"httpPath":"/organisations/{orgId}/extensions/eudr/references/resolve"},{"label":"Retrieve DDS Reference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferences_read","routeSlug":"/reference/api/eudr/ddsreferences_read","metadata":{"seo":{"title":"Retrieve DDS Reference","description":"Retrieves an existing EUDR DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferences_read","name":"Retrieve DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing EUDR DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","href":"eudr/ddsreferences_read","openApiOperationId":"DDSReferences_read","summary":"Retrieve DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReference"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDSReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferences_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}"},{"label":"Update DDS Reference","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferences_update","routeSlug":"/reference/api/eudr/ddsreferences_update","metadata":{"seo":{"title":"Update DDS Reference","description":"Updates an existing EUDR DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferences_update","name":"Update DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing EUDR DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","href":"eudr/ddsreferences_update","openApiOperationId":"DDSReferences_update","summary":"Update DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReference"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDSReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferences_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}"},{"label":"Delete DDS Reference","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferences_delete","routeSlug":"/reference/api/eudr/ddsreferences_delete","metadata":{"seo":{"title":"Delete DDS Reference","description":"Deletes an DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferences_delete","name":"Delete DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","href":"eudr/ddsreferences_delete","openApiOperationId":"DDSReferences_delete","summary":"Delete DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferences_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}"},{"label":"Add Direct Record(s)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferencedirectrecords_create","routeSlug":"/reference/api/eudr/ddsreferencedirectrecords_create","metadata":{"seo":{"title":"Add Direct Record(s)","description":"Creates an EUDR DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferenceDirectRecords_create","name":"Add Direct Record(s)","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Direct Record(s)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an EUDR DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"schemaId":"components/schemas/Integrations.Eudr.DirectRecords","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","href":"eudr/ddsreferencedirectrecords_create","openApiOperationId":"DDSReferenceDirectRecords_create","summary":"Add Direct Record(s)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.DirectRecords","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}},"schemaId":"schema_6","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_6","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferencedirectrecords_create"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records"},{"label":"Delete Direct Records","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferencedirectrecords_delete","routeSlug":"/reference/api/eudr/ddsreferencedirectrecords_delete","metadata":{"seo":{"title":"Delete Direct Records","description":"Deletes direct records from a DDS Reference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferenceDirectRecords_delete","name":"Delete Direct Records","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Direct Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes direct records from a DDS Reference."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"schemaId":"components/schemas/Integrations.Eudr.DirectRecords","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","href":"eudr/ddsreferencedirectrecords_delete","openApiOperationId":"DDSReferenceDirectRecords_delete","summary":"Delete Direct Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.DirectRecords","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DirectRecords"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferencedirectrecords_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records"},{"label":"Retrieve Direct Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferencedirectrecords_list","routeSlug":"/reference/api/eudr/ddsreferencedirectrecords_list","metadata":{"seo":{"title":"Retrieve Direct Records","description":"Gets the list of DDS Reference Direct Records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferenceDirectRecords_list","name":"Retrieve Direct Records","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Direct Records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of DDS Reference Direct Records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","href":"eudr/ddsreferencedirectrecords_list","openApiOperationId":"DDSReferenceDirectRecords_list","summary":"Retrieve Direct Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1direct-records/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferencedirectrecords_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records"},{"label":"Retract DDS Reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferenceretract_retract","routeSlug":"/reference/api/eudr/ddsreferenceretract_retract","metadata":{"seo":{"title":"Retract DDS Reference","description":"Retracts (withdraws) a submitted Due Diligence Statement from Traces NT. Only references where withdrawable is true can be retracted. On success the updated DDS Reference is returned; its status will reflect the withdrawal once Traces NT has processed it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferenceRetract_retract","name":"Retract DDS Reference","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1retract/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retract DDS Reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retracts (withdraws) a submitted Due Diligence Statement from Traces NT. Only references where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true can be retracted. On success the updated DDS Reference is returned; its status will reflect the withdrawal once Traces NT has processed it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1retract/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/retract","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/retract","href":"eudr/ddsreferenceretract_retract","openApiOperationId":"DDSReferenceRetract_retract","summary":"Retract DDS Reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReference"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1retract/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDSReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferenceretract_retract"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/retract"},{"label":"Retrieve Source Data References","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddsreferencesourcedata_read","routeSlug":"/reference/api/eudr/ddsreferencesourcedata_read","metadata":{"seo":{"title":"Retrieve Source Data References","description":"Retrieve Source Data for references"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDSReferenceSourceData_read","name":"Retrieve Source Data References","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1source-data/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Source Data References","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve Source Data for references"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1source-data/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/source-data","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/source-data","href":"eudr/ddsreferencesourcedata_read","openApiOperationId":"DDSReferenceSourceData_read","summary":"Retrieve Source Data References"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1source-data/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddsreferencesourcedata_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/source-data"},{"label":"Retrieve Generated/Updated Due Diligence Statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddstatements_read","routeSlug":"/reference/api/eudr/ddstatements_read","metadata":{"seo":{"title":"Retrieve Generated/Updated Due Diligence Statement","description":"Retrieves an existing EUDR DDS Statement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDStatements_read","name":"Retrieve Generated/Updated Due Diligence Statement","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Generated/Updated Due Diligence Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing EUDR DDS Statement."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","href":"eudr/ddstatements_read","openApiOperationId":"DDStatements_read","summary":"Retrieve Generated/Updated Due Diligence Statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}},"schemaId":"components/schemas/Integrations.Eudr.DDStatement"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddstatements_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements"},{"label":"Update DDS Statement","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddstatements_update","routeSlug":"/reference/api/eudr/ddstatements_update","metadata":{"seo":{"title":"Update DDS Statement","description":"Updates the non-derived fields that are part of the DDS Statement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDStatements_update","name":"Update DDS Statement","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update DDS Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the non-derived fields that are part of the DDS Statement."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSUpdate"}},"schemaId":"components/schemas/Integrations.Eudr.DDSUpdate","pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","href":"eudr/ddstatements_update","openApiOperationId":"DDStatements_update","summary":"Update DDS Statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Integrations.Eudr.DDSUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}},"schemaId":"components/schemas/Integrations.Eudr.DDStatement"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddstatements_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements"},{"label":"Regenerate Due Diligence Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddstatements_regenerate","routeSlug":"/reference/api/eudr/ddstatements_regenerate","metadata":{"seo":{"title":"Regenerate Due Diligence Statement","description":"Regenerate the Due Diligence Statement. It will undo any specific updates as it rebuilds from the attached records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDStatements_regenerate","name":"Regenerate Due Diligence Statement","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1regenerate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate Due Diligence Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Regenerate the Due Diligence Statement. It will undo any specific updates as it rebuilds from the attached records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1regenerate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/regenerate","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/regenerate","href":"eudr/ddstatements_regenerate","openApiOperationId":"DDStatements_regenerate","summary":"Regenerate Due Diligence Statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}},"schemaId":"components/schemas/Integrations.Eudr.DDStatement"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1regenerate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDStatement"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddstatements_regenerate"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/regenerate"},{"label":"Submit Due Diligence Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/eudr/ddstatements_submit","routeSlug":"/reference/api/eudr/ddstatements_submit","metadata":{"seo":{"title":"Submit Due Diligence Statement","description":"Submit the Due Diligence Statement to the Traces NT System."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DDStatements_submit","name":"Submit Due Diligence Statement","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1submit/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Due Diligence Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit the Due Diligence Statement to the Traces NT System."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"referenceId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1submit/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/submit","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"referenceId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/submit","href":"eudr/ddstatements_submit","openApiOperationId":"DDStatements_submit","summary":"Submit Due Diligence Statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}},"schemaId":"components/schemas/Integrations.Eudr.DDSReference"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1extensions~1eudr~1references~1{referenceId}~1statements~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Integrations.Eudr.DDSReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Integrations.Eudr.DDSReference"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eudr/ddstatements_submit"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/submit"}],"content":{"contentType":"group","meta":{"name":"EUDR"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EUDR","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to EUDR and Due Diligence Statement Submission."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/extensions/eudr/credentials","summary":"Create Credential","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/credentials_create","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/credentials","summary":"Retrieve Credential List ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/credentials_list","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","summary":"Retrieve Credential","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/credentials_read","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","summary":"Update Credential","prefix":{"name":"put","color":"put"},"badges":[],"link":"/eudr/credentials_update","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/credentials/{credentialsId}","summary":"Delete Credential","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/eudr/credentials_delete","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references","summary":"Create DDS Reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/ddsreferences_create","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references","summary":"Retrieve DDS Reference List ","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/ddsreferences_list","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/find","summary":"Find DDS Reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/findddsreferences_find","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/resolve","summary":"Resolve DDS Reference","prefix":{"name":"post","color":"post"},"badges":[{"name":"Work In Progress","color":"#0068ff"}],"link":"/eudr/resolveddsreferences_resolve","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","summary":"Retrieve DDS Reference","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/ddsreferences_read","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","summary":"Update DDS Reference","prefix":{"name":"put","color":"put"},"badges":[],"link":"/eudr/ddsreferences_update","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}","summary":"Delete DDS Reference","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/eudr/ddsreferences_delete","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","summary":"Add Direct Record(s)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/ddsreferencedirectrecords_create","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","summary":"Delete Direct Records","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/eudr/ddsreferencedirectrecords_delete","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/direct-records","summary":"Retrieve Direct Records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/ddsreferencedirectrecords_list","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/retract","summary":"Retract DDS Reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/ddsreferenceretract_retract","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/source-data","summary":"Retrieve Source Data References","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/ddsreferencesourcedata_read","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","summary":"Retrieve Generated/Updated Due Diligence Statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eudr/ddstatements_read","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements","summary":"Update DDS Statement","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/eudr/ddstatements_update","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/regenerate","summary":"Regenerate Due Diligence Statement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/ddstatements_regenerate","deprecated":false},{"title":"/organisations/{orgId}/extensions/eudr/references/{referenceId}/statements/submit","summary":"Submit Due Diligence Statement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eudr/ddstatements_submit","deprecated":false}]}]}]}]}},{"type":"separator","label":"Static","content":null},{"type":"group","label":"Connections","link":"/reference/api/connections","routeSlug":"/reference/api/connections","items":[{"label":"Create Connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_post","routeSlug":"/reference/api/connections/connections_post","metadata":{"seo":{"title":"Create Connection","description":"Adds a new connection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_post","name":"Create Connection","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Connection","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.ConnectionCreate"}},"schemaId":"components/schemas/Static.ConnectionCreate","pointer":"/paths/~1organisations~1{orgId}~1connections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/connections","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.ConnectionCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/connections","href":"connections/connections_post","openApiOperationId":"Connections_post","summary":"Create Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.ConnectionCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.ConnectionCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}},"schemaId":"components/schemas/Static.Connection","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.Connection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/connections"},{"label":"Retrieve Connection List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_list","routeSlug":"/reference/api/connections/connections_list","metadata":{"seo":{"title":"Retrieve Connection List","description":"Gets the list of connections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_list","name":"Retrieve Connection List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Connection List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of connections."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across connection fields."},{"name":"name","in":"query","explode":false,"schemaId":"schema_0","description":"The name of the Connection."},{"name":"country","in":"query","explode":false,"schemaId":"schema_0","description":"The country that the Connection is based in."},{"name":"parentUri","in":"query","explode":false,"schemaId":"schema_0","description":"The parent Uri if set."},{"name":"publicUri","in":"query","explode":false,"schemaId":"schema_0","description":"This is the public organisation URI."},{"name":"hasPublicUri","in":"query","explode":false,"schemaId":"schema_5","description":"Will return all connections where they have a public URI."},{"name":"hasConnectStatus","in":"query","explode":false,"schemaId":"schema_5","description":"Will return all connections where a connect status has been set."},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7","description":"The record 'State' of the Connection"},{"name":"connectStatus","in":"query","explode":false,"schemaId":"schema_29","description":"Whether or not the Connection has an established link between their Interu account and yours."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1connections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/connections","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"country","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"parentUri","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"publicUri","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"hasPublicUri","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"hasConnectStatus","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"connectStatus","in":"query","required":false,"schemaId":"components/schemas/Static.ConnectStatus","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/connections","href":"connections/connections_list","openApiOperationId":"Connections_list","summary":"Retrieve Connection List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_30"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/connections"},{"label":"Retrieve Connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_read","routeSlug":"/reference/api/connections/connections_read","metadata":{"seo":{"title":"Retrieve Connection","description":"Retrieve an existing connection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_read","name":"Retrieve Connection","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an existing connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectionId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/connections/{connectionId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"connectionId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/connections/{connectionId}","href":"connections/connections_read","openApiOperationId":"Connections_read","summary":"Retrieve Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}},"schemaId":"components/schemas/Static.Connection"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Connection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/connections/{connectionId}"},{"label":"Update Connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_update","routeSlug":"/reference/api/connections/connections_update","metadata":{"seo":{"title":"Update Connection","description":"Update the details of an existing connection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_update","name":"Update Connection","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of an existing connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectionId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnection"}},"schemaId":"components/schemas/Static.UpdateConnection","pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/connections/{connectionId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"connectionId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnection"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/connections/{connectionId}","href":"connections/connections_update","openApiOperationId":"Connections_update","summary":"Update Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateConnection","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnection"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}},"schemaId":"components/schemas/Static.Connection"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Connection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/connections/{connectionId}"},{"label":"Patch Connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_patch","routeSlug":"/reference/api/connections/connections_patch","metadata":{"seo":{"title":"Patch Connection","description":"Update selected details of an existing connection. Only the fields supplied in the request body are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_patch","name":"Patch Connection","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update selected details of an existing connection. Only the fields supplied in the request body are changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectionId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnectionUpdate"}},"schemaId":"components/schemas/Static.UpdateConnectionUpdate","pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/organisations/{orgId}/connections/{connectionId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"connectionId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnectionUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/connections/{connectionId}","href":"connections/connections_patch","openApiOperationId":"Connections_patch","summary":"Patch Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateConnectionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateConnectionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}},"schemaId":"components/schemas/Static.Connection"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Connection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Connection"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_patch"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/connections/{connectionId}"},{"label":"Delete Connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/connections/connections_delete","routeSlug":"/reference/api/connections/connections_delete","metadata":{"seo":{"title":"Delete Connection","description":"Delete an existing connection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Connections_delete","name":"Delete Connection","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an existing connection."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"connectionId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/connections/{connectionId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"connectionId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/connections/{connectionId}","href":"connections/connections_delete","openApiOperationId":"Connections_delete","summary":"Delete Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1connections~1{connectionId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connections/connections_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/connections/{connectionId}"}],"content":{"contentType":"group","meta":{"name":"Connections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connections","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Connections."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/connections","summary":"Create Connection","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/connections/connections_post","deprecated":false},{"title":"/organisations/{orgId}/connections","summary":"Retrieve Connection List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connections/connections_list","deprecated":false},{"title":"/organisations/{orgId}/connections/{connectionId}","summary":"Retrieve Connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connections/connections_read","deprecated":false},{"title":"/organisations/{orgId}/connections/{connectionId}","summary":"Update Connection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/connections/connections_update","deprecated":false},{"title":"/organisations/{orgId}/connections/{connectionId}","summary":"Patch Connection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/connections/connections_patch","deprecated":false},{"title":"/organisations/{orgId}/connections/{connectionId}","summary":"Delete Connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/connections/connections_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Locations","link":"/reference/api/locations","routeSlug":"/reference/api/locations","items":[{"label":"Create LocationLink","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locationlinks_post","routeSlug":"/reference/api/locations/locationlinks_post","metadata":{"seo":{"title":"Create LocationLink","description":"Add a link between two locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationLinks_post","name":"Create LocationLink","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create LocationLink","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a link between two locations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.LocationLinkCreate"}},"schemaId":"components/schemas/Static.LocationLinkCreate","pointer":"/paths/~1organisations~1{orgId}~1location-links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/location-links","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.LocationLinkCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/location-links","href":"locations/locationlinks_post","openApiOperationId":"LocationLinks_post","summary":"Create LocationLink"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.LocationLinkCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.LocationLinkCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.LocationLink"}},"schemaId":"components/schemas/Static.LocationLink","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.LocationLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.LocationLink"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locationlinks_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-links"},{"label":"Retrieve LocationLink List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locationlinks_list","routeSlug":"/reference/api/locations/locationlinks_list","metadata":{"seo":{"title":"Retrieve LocationLink List","description":"Get list of location links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationLinks_list","name":"Retrieve LocationLink List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve LocationLink List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of location links. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"locationUri","in":"query","explode":false,"schemaId":"schema_17"},{"name":"linkDirection","in":"query","explode":false,"schemaId":"schema_31"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/location-links","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"locationUri","in":"query","required":false,"schemaId":"schema_17","explode":false},{"name":"linkDirection","in":"query","required":false,"schemaId":"components/schemas/Static.QueryLinkDirection","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/location-links","href":"locations/locationlinks_list","openApiOperationId":"LocationLinks_list","summary":"Retrieve LocationLink List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-links/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locationlinks_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-links"},{"label":"Retrieve LocationLink","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locationlinks_read","routeSlug":"/reference/api/locations/locationlinks_read","metadata":{"seo":{"title":"Retrieve LocationLink","description":"Retrieve an exisitng link between two locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationLinks_read","name":"Retrieve LocationLink","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve LocationLink","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an exisitng link between two locations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"linkId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/location-links/{linkId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"linkId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/location-links/{linkId}","href":"locations/locationlinks_read","openApiOperationId":"LocationLinks_read","summary":"Retrieve LocationLink"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.LocationLink"}},"schemaId":"components/schemas/Static.LocationLink"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.LocationLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.LocationLink"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locationlinks_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-links/{linkId}"},{"label":"Delete LocationLink","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locationlinks_delete","routeSlug":"/reference/api/locations/locationlinks_delete","metadata":{"seo":{"title":"Delete LocationLink","description":"Delete a link between two locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"LocationLinks_delete","name":"Delete LocationLink","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete LocationLink","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a link between two locations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"linkId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/location-links/{linkId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"linkId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/location-links/{linkId}","href":"locations/locationlinks_delete","openApiOperationId":"LocationLinks_delete","summary":"Delete LocationLink"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1location-links~1{linkId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locationlinks_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/location-links/{linkId}"},{"label":"Create Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locations_post","routeSlug":"/reference/api/locations/locations_post","metadata":{"seo":{"title":"Create Location","description":"Adds a new location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Locations_post","name":"Create Location","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1locations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Location","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.LocationCreate"}},"schemaId":"components/schemas/Static.LocationCreate","pointer":"/paths/~1organisations~1{orgId}~1locations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/locations","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.LocationCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/locations","href":"locations/locations_post","openApiOperationId":"Locations_post","summary":"Create Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.LocationCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.LocationCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}},"schemaId":"components/schemas/Static.Location","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1locations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.Location","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locations_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/locations"},{"label":"Retrieve Location List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locations_list","routeSlug":"/reference/api/locations/locations_list","metadata":{"seo":{"title":"Retrieve Location List","description":"Gets the list of locations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Locations_list","name":"Retrieve Location List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Location List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of locations. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across location fields."},{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"countryCodes","in":"query","explode":false,"schemaId":"schema_6"},{"name":"typeIds","in":"query","explode":false,"schemaId":"schema_6"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"excludeDownstream","in":"query","explode":false,"schemaId":"schema_5","description":"If true, exclude locations with downstream location types."},{"name":"tagDefinitionIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find locations that are tagged with any of the given tag definitions."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/locations","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"countryCodes","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"typeIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"excludeDownstream","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"tagDefinitionIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/locations","href":"locations/locations_list","openApiOperationId":"Locations_list","summary":"Retrieve Location List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locations_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/locations"},{"label":"Retrieve Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locations_read","routeSlug":"/reference/api/locations/locations_read","metadata":{"seo":{"title":"Retrieve Location","description":"Retrieves an existing location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Locations_read","name":"Retrieve Location","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an existing location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locationId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/locations/{locationId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/locations/{locationId}","href":"locations/locations_read","openApiOperationId":"Locations_read","summary":"Retrieve Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}},"schemaId":"components/schemas/Static.Location"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Location","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locations_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/locations/{locationId}"},{"label":"Update Location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locations_update","routeSlug":"/reference/api/locations/locations_update","metadata":{"seo":{"title":"Update Location","description":"Updates an existing location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Locations_update","name":"Update Location","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locationId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateLocation"}},"schemaId":"components/schemas/Static.UpdateLocation","pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/locations/{locationId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateLocation"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/locations/{locationId}","href":"locations/locations_update","openApiOperationId":"Locations_update","summary":"Update Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateLocation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateLocation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}},"schemaId":"components/schemas/Static.Location"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Location","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Location"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locations_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/locations/{locationId}"},{"label":"Delete Location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/locations/locations_delete","routeSlug":"/reference/api/locations/locations_delete","metadata":{"seo":{"title":"Delete Location","description":"Delete an existing location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Locations_delete","name":"Delete Location","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an existing location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"locationId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/locations/{locationId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"locationId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/locations/{locationId}","href":"locations/locations_delete","openApiOperationId":"Locations_delete","summary":"Delete Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1locations~1{locationId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/locations_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/locations/{locationId}"}],"content":{"contentType":"group","meta":{"name":"Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Locations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/location-links","summary":"Create LocationLink","prefix":{"name":"post","color":"post"},"badges":[],"link":"/locations/locationlinks_post","deprecated":false},{"title":"/organisations/{orgId}/location-links","summary":"Retrieve LocationLink List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/locationlinks_list","deprecated":false},{"title":"/organisations/{orgId}/location-links/{linkId}","summary":"Retrieve LocationLink","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/locationlinks_read","deprecated":false},{"title":"/organisations/{orgId}/location-links/{linkId}","summary":"Delete LocationLink","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locations/locationlinks_delete","deprecated":false},{"title":"/organisations/{orgId}/locations","summary":"Create Location","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/locations/locations_post","deprecated":false},{"title":"/organisations/{orgId}/locations","summary":"Retrieve Location List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/locations_list","deprecated":false},{"title":"/organisations/{orgId}/locations/{locationId}","summary":"Retrieve Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/locations_read","deprecated":false},{"title":"/organisations/{orgId}/locations/{locationId}","summary":"Update Location","prefix":{"name":"put","color":"put"},"badges":[],"link":"/locations/locations_update","deprecated":false},{"title":"/organisations/{orgId}/locations/{locationId}","summary":"Delete Location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locations/locations_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Materials","link":"/reference/api/materials","routeSlug":"/reference/api/materials","items":[{"label":"Create Material","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/materials/materials_post","routeSlug":"/reference/api/materials/materials_post","metadata":{"seo":{"title":"Create Material","description":"Create Material"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Materials_post","name":"Create Material","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1materials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Material","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.MaterialCreate"}},"schemaId":"components/schemas/Static.MaterialCreate","pointer":"/paths/~1organisations~1{orgId}~1materials/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/materials","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.MaterialCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/materials","href":"materials/materials_post","openApiOperationId":"Materials_post","summary":"Create Material"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.MaterialCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.MaterialCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}},"schemaId":"components/schemas/Static.Material","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1materials/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.Material","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/materials/materials_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/materials"},{"label":"Retrieve Material List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/materials/materials_list","routeSlug":"/reference/api/materials/materials_list","metadata":{"seo":{"title":"Retrieve Material List","description":"Retrieve Material List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Materials_list","name":"Retrieve Material List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1materials/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Material List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across material fields."},{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"category","in":"query","explode":false,"schemaId":"schema_0"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1materials/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/materials","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"category","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/materials","href":"materials/materials_list","openApiOperationId":"Materials_list","summary":"Retrieve Material List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1materials/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/materials/materials_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/materials"},{"label":"Retrieve Material","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/materials/materials_read","routeSlug":"/reference/api/materials/materials_read","metadata":{"seo":{"title":"Retrieve Material","description":"Retrieve Material"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Materials_read","name":"Retrieve Material","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Material","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"materialId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/materials/{materialId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"materialId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/materials/{materialId}","href":"materials/materials_read","openApiOperationId":"Materials_read","summary":"Retrieve Material"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}},"schemaId":"components/schemas/Static.Material"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Material","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/materials/materials_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/materials/{materialId}"},{"label":"Update Material","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/materials/materials_update","routeSlug":"/reference/api/materials/materials_update","metadata":{"seo":{"title":"Update Material","description":"Update Material"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Materials_update","name":"Update Material","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Material","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"materialId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateMaterial"}},"schemaId":"components/schemas/Static.UpdateMaterial","pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/materials/{materialId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"materialId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateMaterial"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/materials/{materialId}","href":"materials/materials_update","openApiOperationId":"Materials_update","summary":"Update Material"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateMaterial","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateMaterial"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}},"schemaId":"components/schemas/Static.Material"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Material","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Material"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/materials/materials_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/materials/{materialId}"},{"label":"Delete Material","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/materials/materials_delete","routeSlug":"/reference/api/materials/materials_delete","metadata":{"seo":{"title":"Delete Material","description":"Delete Material"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Materials_delete","name":"Delete Material","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Material","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"materialId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/materials/{materialId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"materialId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/materials/{materialId}","href":"materials/materials_delete","openApiOperationId":"Materials_delete","summary":"Delete Material"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1materials~1{materialId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/materials/materials_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/materials/{materialId}"}],"content":{"contentType":"group","meta":{"name":"Materials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Materials","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Materials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/materials","summary":"Create Material","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/materials/materials_post","deprecated":false},{"title":"/organisations/{orgId}/materials","summary":"Retrieve Material List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/materials/materials_list","deprecated":false},{"title":"/organisations/{orgId}/materials/{materialId}","summary":"Retrieve Material","prefix":{"name":"get","color":"get"},"badges":[],"link":"/materials/materials_read","deprecated":false},{"title":"/organisations/{orgId}/materials/{materialId}","summary":"Update Material","prefix":{"name":"put","color":"put"},"badges":[],"link":"/materials/materials_update","deprecated":false},{"title":"/organisations/{orgId}/materials/{materialId}","summary":"Delete Material","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/materials/materials_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/reference/api/products","routeSlug":"/reference/api/products","items":[{"label":"Create Product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/products_post","routeSlug":"/reference/api/products/products_post","metadata":{"seo":{"title":"Create Product","description":"Add a new product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Products_post","name":"Create Product","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Product","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.ProductCreate"}},"schemaId":"components/schemas/Static.ProductCreate","pointer":"/paths/~1organisations~1{orgId}~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/products","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.ProductCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/products","href":"products/products_post","openApiOperationId":"Products_post","summary":"Create Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.ProductCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.ProductCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}},"schemaId":"components/schemas/Static.Product","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/products_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/products"},{"label":"Retrieve Product List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/products_list","routeSlug":"/reference/api/products/products_list","metadata":{"seo":{"title":"Retrieve Product List","description":"Gets the list of products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Products_list","name":"Retrieve Product List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Product List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of products."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across product fields."},{"name":"name","in":"query","explode":false,"schemaId":"schema_0"},{"name":"material","in":"query","explode":false,"schemaId":"schema_0"},{"name":"category","in":"query","explode":false,"schemaId":"schema_0"},{"name":"baseUnit","in":"query","explode":false,"schemaId":"schema_17"},{"name":"baseUnitType","in":"query","explode":false,"schemaId":"schema_35"},{"name":"allowedMaterialIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find products that permit any of the given materials."},{"name":"baseUnitIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find products that use any of the given base units."},{"name":"baseUnitTypes","in":"query","explode":false,"schemaId":"schema_36","description":"Find products whose base unit is of any of the given types."},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/products","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"name","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"material","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"category","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"baseUnit","in":"query","required":false,"schemaId":"schema_17","explode":false},{"name":"baseUnitType","in":"query","required":false,"schemaId":"components/schemas/Common.BaseUnitType","explode":false},{"name":"allowedMaterialIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"baseUnitIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"baseUnitTypes","in":"query","required":false,"schemaId":"schema_36","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/products","href":"products/products_list","openApiOperationId":"Products_list","summary":"Retrieve Product List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/products_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products"},{"label":"Retrieve Product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/products_read","routeSlug":"/reference/api/products/products_read","metadata":{"seo":{"title":"Retrieve Product","description":"Retrieve an existing product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Products_read","name":"Retrieve Product","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an existing product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/products/{productId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}","href":"products/products_read","openApiOperationId":"Products_read","summary":"Retrieve Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}},"schemaId":"components/schemas/Static.Product"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/products_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}"},{"label":"Update Product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/products_update","routeSlug":"/reference/api/products/products_update","metadata":{"seo":{"title":"Update Product","description":"Update an existing product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Products_update","name":"Update Product","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateProduct"}},"schemaId":"components/schemas/Static.UpdateProduct","pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/products/{productId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateProduct"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}","href":"products/products_update","openApiOperationId":"Products_update","summary":"Update Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}},"schemaId":"components/schemas/Static.Product"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/products_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}"},{"label":"Delete Product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/products_delete","routeSlug":"/reference/api/products/products_delete","metadata":{"seo":{"title":"Delete Product","description":"Delete a product. This will only work if the product is not referenced in any items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Products_delete","name":"Delete Product","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a product. This will only work if the product is not referenced in any items."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/products/{productId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}","href":"products/products_delete","openApiOperationId":"Products_delete","summary":"Delete Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/products_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}"},{"label":"Create Variant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/variants_post","routeSlug":"/reference/api/products/variants_post","metadata":{"seo":{"title":"Create Variant","description":"Add a new product variant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Variants_post","name":"Create Variant","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Variant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new product variant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.VariantCreate"}},"schemaId":"components/schemas/Static.VariantCreate","pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/products/{productId}/variants","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.VariantCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/products/{productId}/variants","href":"products/variants_post","openApiOperationId":"Variants_post","summary":"Create Variant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.VariantCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.VariantCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}},"schemaId":"components/schemas/Static.Variant","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Static.Variant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/variants_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}/variants"},{"label":"Retrieve Variant List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/variants_list","routeSlug":"/reference/api/products/variants_list","metadata":{"seo":{"title":"Retrieve Variant List","description":"Gets the list of product variants."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Variants_list","name":"Retrieve Variant List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Variant List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of product variants."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"description","in":"query","explode":false,"schemaId":"schema_0"},{"name":"sku","in":"query","explode":false,"schemaId":"schema_0"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/products/{productId}/variants","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"description","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"sku","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/products/{productId}/variants","href":"products/variants_list","openApiOperationId":"Variants_list","summary":"Retrieve Variant List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/variants_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}/variants"},{"label":"Retrieve Variant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/variants_read","routeSlug":"/reference/api/products/variants_read","metadata":{"seo":{"title":"Retrieve Variant","description":"Retrieve an existing product variant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Variants_read","name":"Retrieve Variant","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Variant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an existing product variant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"variantId","in":"path","schemaId":"schema_0","required":true},{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/products/{productId}/variants/{variantId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"variantId","in":"path","required":true,"schemaId":"schema_0"},{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}/variants/{variantId}","href":"products/variants_read","openApiOperationId":"Variants_read","summary":"Retrieve Variant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}},"schemaId":"components/schemas/Static.Variant"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Variant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/variants_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}/variants/{variantId}"},{"label":"Update Variant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/variants_update","routeSlug":"/reference/api/products/variants_update","metadata":{"seo":{"title":"Update Variant","description":"Update an existing product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Variants_update","name":"Update Variant","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Variant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"variantId","in":"path","schemaId":"schema_0","required":true},{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateVariant"}},"schemaId":"components/schemas/Static.UpdateVariant","pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/products/{productId}/variants/{variantId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"variantId","in":"path","required":true,"schemaId":"schema_0"},{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Static.UpdateVariant"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}/variants/{variantId}","href":"products/variants_update","openApiOperationId":"Variants_update","summary":"Update Variant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Static.UpdateVariant","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Static.UpdateVariant"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}},"schemaId":"components/schemas/Static.Variant"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Static.Variant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Static.Variant"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/variants_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}/variants/{variantId}"},{"label":"Delete Product Variant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/products/variants_delete","routeSlug":"/reference/api/products/variants_delete","metadata":{"seo":{"title":"Delete Product Variant","description":"Delete a product. This will only work if the product is not referenced in any items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Variants_delete","name":"Delete Product Variant","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Product Variant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a product. This will only work if the product is not referenced in any items."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"variantId","in":"path","schemaId":"schema_0","required":true},{"name":"productId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/products/{productId}/variants/{variantId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"variantId","in":"path","required":true,"schemaId":"schema_0"},{"name":"productId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/products/{productId}/variants/{variantId}","href":"products/variants_delete","openApiOperationId":"Variants_delete","summary":"Delete Product Variant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1products~1{productId}~1variants~1{variantId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/variants_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/products/{productId}/variants/{variantId}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/products","summary":"Create Product","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/products/products_post","deprecated":false},{"title":"/organisations/{orgId}/products","summary":"Retrieve Product List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/products_list","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}","summary":"Retrieve Product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/products_read","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}","summary":"Update Product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/products_update","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}","summary":"Delete Product","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/products_delete","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}/variants","summary":"Create Variant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/variants_post","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}/variants","summary":"Retrieve Variant List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/variants_list","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}/variants/{variantId}","summary":"Retrieve Variant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/variants_read","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}/variants/{variantId}","summary":"Update Variant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/variants_update","deprecated":false},{"title":"/organisations/{orgId}/products/{productId}/variants/{variantId}","summary":"Delete Product Variant","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/variants_delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transactional","content":null},{"type":"group","label":"Deliveries","link":"/reference/api/deliveries","routeSlug":"/reference/api/deliveries","items":[{"label":"Create Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/deliveries/deliveries_post","routeSlug":"/reference/api/deliveries/deliveries_post","metadata":{"seo":{"title":"Create Delivery","description":"Create Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deliveries_post","name":"Create Delivery","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1deliveries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Delivery","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.DeliveryCreate"}},"schemaId":"components/schemas/Transactional.DeliveryCreate","pointer":"/paths/~1organisations~1{orgId}~1deliveries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/deliveries","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.DeliveryCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/deliveries","href":"deliveries/deliveries_post","openApiOperationId":"Deliveries_post","summary":"Create Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.DeliveryCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.DeliveryCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}},"schemaId":"components/schemas/Transactional.Delivery","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliveries/deliveries_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/deliveries"},{"label":"Retrieve Delivery List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/deliveries/deliveries_list","routeSlug":"/reference/api/deliveries/deliveries_list","metadata":{"seo":{"title":"Retrieve Delivery List","description":"Retrieve Delivery List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deliveries_list","name":"Retrieve Delivery List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1deliveries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Delivery List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across delivery fields."},{"name":"deliveryId","in":"query","explode":false,"schemaId":"schema_0"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"status","in":"query","explode":false,"schemaId":"schema_39"},{"name":"purchaseOrderNumber","in":"query","explode":false,"schemaId":"schema_0"},{"name":"hasSupplyChain","in":"query","explode":false,"schemaId":"schema_5","description":"Filter deliveries that have a supply chain associated."},{"name":"supplyChainId","in":"query","explode":false,"schemaId":"schema_0","description":"Filter deliveries by supply chain ID."},{"name":"fromLocationId","in":"query","explode":false,"schemaId":"schema_0","description":"Find deliveries that depart from the given location."},{"name":"fromLocationIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find deliveries that depart from any of the given locations."},{"name":"toLocationId","in":"query","explode":false,"schemaId":"schema_0","description":"Find deliveries that arrive at the given location."},{"name":"toLocationIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find deliveries that arrive at any of the given locations."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/deliveries","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"deliveryId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"status","in":"query","required":false,"schemaId":"components/schemas/Transactional.DeliveryStatus","explode":false},{"name":"purchaseOrderNumber","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"hasSupplyChain","in":"query","required":false,"schemaId":"schema_5","explode":false},{"name":"supplyChainId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"fromLocationId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"fromLocationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"toLocationId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"toLocationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/deliveries","href":"deliveries/deliveries_list","openApiOperationId":"Deliveries_list","summary":"Retrieve Delivery List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliveries/deliveries_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/deliveries"},{"label":"Retrieve Delivery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/deliveries/deliveries_read","routeSlug":"/reference/api/deliveries/deliveries_read","metadata":{"seo":{"title":"Retrieve Delivery","description":"Retrieve Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deliveries_read","name":"Retrieve Delivery","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/deliveries/{deliveryId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"deliveryId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/deliveries/{deliveryId}","href":"deliveries/deliveries_read","openApiOperationId":"Deliveries_read","summary":"Retrieve Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}},"schemaId":"components/schemas/Transactional.Delivery"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliveries/deliveries_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/deliveries/{deliveryId}"},{"label":"Update Delivery","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/deliveries/deliveries_update","routeSlug":"/reference/api/deliveries/deliveries_update","metadata":{"seo":{"title":"Update Delivery","description":"Update Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deliveries_update","name":"Update Delivery","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateDelivery"}},"schemaId":"components/schemas/Transactional.UpdateDelivery","pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/deliveries/{deliveryId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"deliveryId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateDelivery"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/deliveries/{deliveryId}","href":"deliveries/deliveries_update","openApiOperationId":"Deliveries_update","summary":"Update Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.UpdateDelivery","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateDelivery"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}},"schemaId":"components/schemas/Transactional.Delivery"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Delivery","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Delivery"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliveries/deliveries_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/deliveries/{deliveryId}"},{"label":"Delete Delivery","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/deliveries/deliveries_delete","routeSlug":"/reference/api/deliveries/deliveries_delete","metadata":{"seo":{"title":"Delete Delivery","description":"Delete Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Deliveries_delete","name":"Delete Delivery","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/deliveries/{deliveryId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"deliveryId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/deliveries/{deliveryId}","href":"deliveries/deliveries_delete","openApiOperationId":"Deliveries_delete","summary":"Delete Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1deliveries~1{deliveryId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliveries/deliveries_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/deliveries/{deliveryId}"}],"content":{"contentType":"group","meta":{"name":"Deliveries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deliveries","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Deliveries."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/deliveries","summary":"Create Delivery","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/deliveries/deliveries_post","deprecated":false},{"title":"/organisations/{orgId}/deliveries","summary":"Retrieve Delivery List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliveries/deliveries_list","deprecated":false},{"title":"/organisations/{orgId}/deliveries/{deliveryId}","summary":"Retrieve Delivery","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliveries/deliveries_read","deprecated":false},{"title":"/organisations/{orgId}/deliveries/{deliveryId}","summary":"Update Delivery","prefix":{"name":"put","color":"put"},"badges":[],"link":"/deliveries/deliveries_update","deprecated":false},{"title":"/organisations/{orgId}/deliveries/{deliveryId}","summary":"Delete Delivery","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/deliveries/deliveries_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Items","link":"/reference/api/items","routeSlug":"/reference/api/items","items":[{"label":"Create Item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/items/items_post","routeSlug":"/reference/api/items/items_post","metadata":{"seo":{"title":"Create Item","description":"Add a stock item to the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Items_post","name":"Create Item","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Item","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a stock item to the system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ItemCreate"}},"schemaId":"components/schemas/Transactional.ItemCreate","pointer":"/paths/~1organisations~1{orgId}~1items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/items","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ItemCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/items","href":"items/items_post","openApiOperationId":"Items_post","summary":"Create Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ItemCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ItemCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}},"schemaId":"components/schemas/Transactional.Item","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.Item","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/items/items_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/items"},{"label":"Retrieve Item List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/items/items_list","routeSlug":"/reference/api/items/items_list","metadata":{"seo":{"title":"Retrieve Item List","description":"Retrieve Item List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Items_list","name":"Retrieve Item List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Item List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across item fields."},{"name":"currentLocation","in":"query","explode":false,"schemaId":"schema_0","description":"Find items that have the provided location."},{"name":"itemId","in":"query","explode":false,"schemaId":"schema_0","description":"Find item with the given item id."},{"name":"productIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find items that have the given product ids."},{"name":"createdAtLocationIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find items that where created at the provided locations."},{"name":"currentLocationIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find items that are at the current location."},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"batchNumbers","in":"query","explode":false,"schemaId":"schema_6","description":"Find any items that have the provided batch numbers."},{"name":"materialIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find items that use any of the given materials."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/items","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"currentLocation","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"itemId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"productIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"createdAtLocationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"currentLocationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"batchNumbers","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"materialIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/items","href":"items/items_list","openApiOperationId":"Items_list","summary":"Retrieve Item List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/items/items_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/items"},{"label":"Retrieve Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/items/items_read","routeSlug":"/reference/api/items/items_read","metadata":{"seo":{"title":"Retrieve Item","description":"Retrieve Item"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Items_read","name":"Retrieve Item","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/items/{itemId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"itemId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/items/{itemId}","href":"items/items_read","openApiOperationId":"Items_read","summary":"Retrieve Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}},"schemaId":"components/schemas/Transactional.Item"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Item","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/items/items_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/items/{itemId}"},{"label":"Update Item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/items/items_update","routeSlug":"/reference/api/items/items_update","metadata":{"seo":{"title":"Update Item","description":"Update Item"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Items_update","name":"Update Item","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateItem"}},"schemaId":"components/schemas/Transactional.UpdateItem","pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/items/{itemId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"itemId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateItem"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/items/{itemId}","href":"items/items_update","openApiOperationId":"Items_update","summary":"Update Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.UpdateItem","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateItem"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}},"schemaId":"components/schemas/Transactional.Item"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Item","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Item"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/items/items_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/items/{itemId}"},{"label":"Delete Item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/items/items_delete","routeSlug":"/reference/api/items/items_delete","metadata":{"seo":{"title":"Delete Item","description":"Delete Item"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Items_delete","name":"Delete Item","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"itemId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/items/{itemId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"itemId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/items/{itemId}","href":"items/items_delete","openApiOperationId":"Items_delete","summary":"Delete Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1items~1{itemId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/items/items_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/items/{itemId}"}],"content":{"contentType":"group","meta":{"name":"Items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Items","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Items."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/items","summary":"Create Item","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/items/items_post","deprecated":false},{"title":"/organisations/{orgId}/items","summary":"Retrieve Item List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/items_list","deprecated":false},{"title":"/organisations/{orgId}/items/{itemId}","summary":"Retrieve Item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/items/items_read","deprecated":false},{"title":"/organisations/{orgId}/items/{itemId}","summary":"Update Item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/items/items_update","deprecated":false},{"title":"/organisations/{orgId}/items/{itemId}","summary":"Delete Item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/items/items_delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Orders","link":"/reference/api/orders","routeSlug":"/reference/api/orders","items":[{"label":"Create Purchase Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_post","routeSlug":"/reference/api/orders/purchaseorders_post","metadata":{"seo":{"title":"Create Purchase Order","description":"Create Purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_post","name":"Create Purchase Order","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Purchase Order","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderCreate"}},"schemaId":"components/schemas/Transactional.PurchaseOrderCreate","pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/purchase-orders","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/purchase-orders","href":"orders/purchaseorders_post","openApiOperationId":"PurchaseOrders_post","summary":"Create Purchase Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.PurchaseOrderCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}},"schemaId":"components/schemas/Transactional.PurchaseOrder","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.PurchaseOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/purchase-orders"},{"label":"Retrieve Purchase Order List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_list","routeSlug":"/reference/api/orders/purchaseorders_list","metadata":{"seo":{"title":"Retrieve Purchase Order List","description":"Retrieve Purchase Order List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_list","name":"Retrieve Purchase Order List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Order List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across purchase order fields."},{"name":"number","in":"query","explode":false,"schemaId":"schema_0"},{"name":"supplierUris","in":"query","explode":false,"schemaId":"schema_6"},{"name":"buyerUris","in":"query","explode":false,"schemaId":"schema_6"},{"name":"deliverToLocationIds","in":"query","explode":false,"schemaId":"schema_6"},{"name":"productIds","in":"query","explode":false,"schemaId":"schema_6"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"status","in":"query","explode":false,"schemaId":"schema_42"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/purchase-orders","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"number","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"supplierUris","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"buyerUris","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"deliverToLocationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"productIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"status","in":"query","required":false,"schemaId":"schema_42","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/purchase-orders","href":"orders/purchaseorders_list","openApiOperationId":"PurchaseOrders_list","summary":"Retrieve Purchase Order List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/purchase-orders"},{"label":"Retrieve Purchase Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_read","routeSlug":"/reference/api/orders/purchaseorders_read","metadata":{"seo":{"title":"Retrieve Purchase Order","description":"Retrieve Purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_read","name":"Retrieve Purchase Order","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Purchase Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"purchaseOrderId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"purchaseOrderId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","href":"orders/purchaseorders_read","openApiOperationId":"PurchaseOrders_read","summary":"Retrieve Purchase Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}},"schemaId":"components/schemas/Transactional.PurchaseOrder"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.PurchaseOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}"},{"label":"Update Purchase Order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_update","routeSlug":"/reference/api/orders/purchaseorders_update","metadata":{"seo":{"title":"Update Purchase Order","description":"Update Purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_update","name":"Update Purchase Order","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"purchaseOrderId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdatePurchaseOrder"}},"schemaId":"components/schemas/Transactional.UpdatePurchaseOrder","pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"purchaseOrderId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.UpdatePurchaseOrder"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","href":"orders/purchaseorders_update","openApiOperationId":"PurchaseOrders_update","summary":"Update Purchase Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.UpdatePurchaseOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdatePurchaseOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}},"schemaId":"components/schemas/Transactional.PurchaseOrder"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.PurchaseOrder","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrder"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}"},{"label":"Delete Purchase Order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_delete","routeSlug":"/reference/api/orders/purchaseorders_delete","metadata":{"seo":{"title":"Delete Purchase Order","description":"Delete Purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_delete","name":"Delete Purchase Order","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Purchase Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"purchaseOrderId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"purchaseOrderId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","href":"orders/purchaseorders_delete","openApiOperationId":"PurchaseOrders_delete","summary":"Delete Purchase Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}"},{"label":"Update Purchase Order Status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/orders/purchaseorders_updatestatus","routeSlug":"/reference/api/orders/purchaseorders_updatestatus","metadata":{"seo":{"title":"Update Purchase Order Status","description":"Update the status of a Purchase Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PurchaseOrders_updateStatus","name":"Update Purchase Order Status","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}~1status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Purchase Order Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the status of a Purchase Order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"purchaseOrderId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}~1status/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderStatusUpdate"}},"schemaId":"components/schemas/Transactional.PurchaseOrderStatusUpdate","pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}~1status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}/status","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"purchaseOrderId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderStatusUpdate"}},"responseCodes":["204","400","401","403","429","500"],"pointer":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}/status","href":"orders/purchaseorders_updatestatus","openApiOperationId":"PurchaseOrders_updateStatus","summary":"Update Purchase Order Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.PurchaseOrderStatusUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.PurchaseOrderStatusUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. ","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/iov42.Core.Responses.NullResponse"}},"schemaId":"components/schemas/iov42.Core.Responses.NullResponse"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1purchase-orders~1{purchaseOrderId}~1status/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204","schemaId":"components/schemas/iov42.Core.Responses.NullResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/iov42.Core.Responses.NullResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/purchaseorders_updatestatus"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}/status"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/purchase-orders","summary":"Create Purchase Order","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/orders/purchaseorders_post","deprecated":false},{"title":"/organisations/{orgId}/purchase-orders","summary":"Retrieve Purchase Order List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/purchaseorders_list","deprecated":false},{"title":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","summary":"Retrieve Purchase Order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/purchaseorders_read","deprecated":false},{"title":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","summary":"Update Purchase Order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/purchaseorders_update","deprecated":false},{"title":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}","summary":"Delete Purchase Order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/purchaseorders_delete","deprecated":false},{"title":"/organisations/{orgId}/purchase-orders/{purchaseOrderId}/status","summary":"Update Purchase Order Status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/purchaseorders_updatestatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Processes","link":"/reference/api/processes","routeSlug":"/reference/api/processes","items":[{"label":"Create Process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processes_post","routeSlug":"/reference/api/processes/processes_post","metadata":{"seo":{"title":"Create Process","description":"Create Process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Processes_post","name":"Create Process","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Process","badges":[{"name":"UDID","color":"#0ca272"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessCreate"}},"schemaId":"components/schemas/Transactional.ProcessCreate","pointer":"/paths/~1organisations~1{orgId}~1processes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/processes","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/processes","href":"processes/processes_post","openApiOperationId":"Processes_post","summary":"Create Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ProcessCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}},"schemaId":"components/schemas/Transactional.Process","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.Process","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processes_post"}],"panels":[]}]},"badges":[{"name":"UDID","color":"#0ca272"}],"httpPath":"/organisations/{orgId}/processes"},{"label":"Retrieve Process List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processes_list","routeSlug":"/reference/api/processes/processes_list","metadata":{"seo":{"title":"Retrieve Process List","description":"Retrieve Process List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Processes_list","name":"Retrieve Process List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Process List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","explode":false,"schemaId":"schema_0","description":"Free-text search across process fields."},{"name":"firstInputDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"lastOutputDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"recordState","in":"query","explode":false,"schemaId":"schema_7"},{"name":"processId","in":"query","explode":false,"schemaId":"schema_0"},{"name":"locationIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find processes that take place at any of the given locations."},{"name":"typeIds","in":"query","explode":false,"schemaId":"schema_6","description":"Find processes that are of any of the given process types."},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1processes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"search","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"firstInputDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"lastOutputDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"recordState","in":"query","required":false,"schemaId":"components/schemas/Common.Enums.RecordState","explode":false},{"name":"processId","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"locationIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"typeIds","in":"query","required":false,"schemaId":"schema_6","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/processes","href":"processes/processes_list","openApiOperationId":"Processes_list","summary":"Retrieve Process List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processes_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes"},{"label":"Retrieve Process","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processes_read","routeSlug":"/reference/api/processes/processes_read","metadata":{"seo":{"title":"Retrieve Process","description":"Retrieve Process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Processes_read","name":"Retrieve Process","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes/{processId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}","href":"processes/processes_read","openApiOperationId":"Processes_read","summary":"Retrieve Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}},"schemaId":"components/schemas/Transactional.Process"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Process","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processes_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}"},{"label":"Update Process","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processes_update","routeSlug":"/reference/api/processes/processes_update","metadata":{"seo":{"title":"Update Process","description":"Update Process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Processes_update","name":"Update Process","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateProcess"}},"schemaId":"components/schemas/Transactional.UpdateProcess","pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/processes/{processId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateProcess"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}","href":"processes/processes_update","openApiOperationId":"Processes_update","summary":"Update Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.UpdateProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.UpdateProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}},"schemaId":"components/schemas/Transactional.Process"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.Process","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.Process"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processes_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}"},{"label":"Delete Process","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processes_delete","routeSlug":"/reference/api/processes/processes_delete","metadata":{"seo":{"title":"Delete Process","description":"Delete Process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Processes_delete","name":"Delete Process","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"processId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/processes/{processId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"processId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}","href":"processes/processes_delete","openApiOperationId":"Processes_delete","summary":"Delete Process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processes_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}"},{"label":"Create ProcessInput","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processinputs_post","routeSlug":"/reference/api/processes/processinputs_post","metadata":{"seo":{"title":"Create ProcessInput","description":"Create ProcessInput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessInputs_post","name":"Create ProcessInput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ProcessInput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreate"}},"schemaId":"components/schemas/Transactional.ProcessInputCreate","pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/processes/{processId}/inputs","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/inputs","href":"processes/processinputs_post","openApiOperationId":"ProcessInputs_post","summary":"Create ProcessInput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ProcessInputCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}},"schemaId":"components/schemas/Transactional.ProcessInput","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.ProcessInput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processinputs_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/inputs"},{"label":"Retrieve ProcessInput List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processinputs_list","routeSlug":"/reference/api/processes/processinputs_list","metadata":{"seo":{"title":"Retrieve ProcessInput List","description":"Retrieve ProcessInput List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessInputs_list","name":"Retrieve ProcessInput List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessInput List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"endDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes/{processId}/inputs","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"startDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"endDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/inputs","href":"processes/processinputs_list","openApiOperationId":"ProcessInputs_list","summary":"Retrieve ProcessInput List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processinputs_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/inputs"},{"label":"Retrieve ProcessInput","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processinputs_read","routeSlug":"/reference/api/processes/processinputs_read","metadata":{"seo":{"title":"Retrieve ProcessInput","description":"Retrieve ProcessInput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessInputs_read","name":"Retrieve ProcessInput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessInput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"inputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","href":"processes/processinputs_read","openApiOperationId":"ProcessInputs_read","summary":"Retrieve ProcessInput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}},"schemaId":"components/schemas/Transactional.ProcessInput"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.ProcessInput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processinputs_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}"},{"label":"Update ProcessInput","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processinputs_update","routeSlug":"/reference/api/processes/processinputs_update","metadata":{"seo":{"title":"Update ProcessInput","description":"Update ProcessInput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessInputs_update","name":"Update ProcessInput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update ProcessInput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreateOrUpdate"}},"schemaId":"components/schemas/Transactional.ProcessInputCreateOrUpdate","pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"inputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreateOrUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","href":"processes/processinputs_update","openApiOperationId":"ProcessInputs_update","summary":"Update ProcessInput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ProcessInputCreateOrUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInputCreateOrUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}},"schemaId":"components/schemas/Transactional.ProcessInput"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.ProcessInput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessInput"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processinputs_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}"},{"label":"Delete ProcessInput","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processinputs_delete","routeSlug":"/reference/api/processes/processinputs_delete","metadata":{"seo":{"title":"Delete ProcessInput","description":"Delete ProcessInput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessInputs_delete","name":"Delete ProcessInput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ProcessInput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"inputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"inputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","href":"processes/processinputs_delete","openApiOperationId":"ProcessInputs_delete","summary":"Delete ProcessInput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1inputs~1{inputId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processinputs_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}"},{"label":"Create ProcessOutput","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processoutputs_post","routeSlug":"/reference/api/processes/processoutputs_post","metadata":{"seo":{"title":"Create ProcessOutput","description":"Create ProcessOutput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessOutputs_post","name":"Create ProcessOutput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ProcessOutput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreate"}},"schemaId":"components/schemas/Transactional.ProcessOutputCreate","pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/processes/{processId}/outputs","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreate"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/outputs","href":"processes/processoutputs_post","openApiOperationId":"ProcessOutputs_post","summary":"Create ProcessOutput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ProcessOutputCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}},"schemaId":"components/schemas/Transactional.ProcessOutput","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Transactional.ProcessOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processoutputs_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/outputs"},{"label":"Retrieve ProcessOutput List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processoutputs_list","routeSlug":"/reference/api/processes/processoutputs_list","metadata":{"seo":{"title":"Retrieve ProcessOutput List","description":"Retrieve ProcessOutput List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessOutputs_list","name":"Retrieve ProcessOutput List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessOutput List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"endDate","in":"query","explode":false,"schemaId":"schema_44"},{"name":"size","in":"query","explode":false,"schemaId":"schema_8","description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20."},{"name":"page","in":"query","explode":false,"schemaId":"schema_9","description":"The pageNo to return. (Zero-based)"},{"name":"sort","in":"query","explode":false,"schemaId":"schema_6","description":"Sort criteria in the format property,direction (e.g. asc,desc)."}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes/{processId}/outputs","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"startDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"endDate","in":"query","required":false,"schemaId":"schema_44","explode":false},{"name":"size","in":"query","required":false,"schemaId":"schema_8","explode":false},{"name":"page","in":"query","required":false,"schemaId":"schema_9","explode":false},{"name":"sort","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/outputs","href":"processes/processoutputs_list","openApiOperationId":"ProcessOutputs_list","summary":"Retrieve ProcessOutput List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processoutputs_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/outputs"},{"label":"Retrieve ProcessOutput","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processoutputs_read","routeSlug":"/reference/api/processes/processoutputs_read","metadata":{"seo":{"title":"Retrieve ProcessOutput","description":"Retrieve ProcessOutput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessOutputs_read","name":"Retrieve ProcessOutput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ProcessOutput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"outputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"outputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","href":"processes/processoutputs_read","openApiOperationId":"ProcessOutputs_read","summary":"Retrieve ProcessOutput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}},"schemaId":"components/schemas/Transactional.ProcessOutput"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.ProcessOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processoutputs_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}"},{"label":"Update ProcessOutput","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processoutputs_update","routeSlug":"/reference/api/processes/processoutputs_update","metadata":{"seo":{"title":"Update ProcessOutput","description":"Update ProcessOutput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessOutputs_update","name":"Update ProcessOutput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update ProcessOutput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"outputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreateOrUpdate"}},"schemaId":"components/schemas/Transactional.ProcessOutputCreateOrUpdate","pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"outputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreateOrUpdate"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","href":"processes/processoutputs_update","openApiOperationId":"ProcessOutputs_update","summary":"Update ProcessOutput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Transactional.ProcessOutputCreateOrUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutputCreateOrUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}},"schemaId":"components/schemas/Transactional.ProcessOutput"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transactional.ProcessOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transactional.ProcessOutput"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processoutputs_update"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}"},{"label":"Delete ProcessOutput","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/processes/processoutputs_delete","routeSlug":"/reference/api/processes/processoutputs_delete","metadata":{"seo":{"title":"Delete ProcessOutput","description":"Delete ProcessOutput"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ProcessOutputs_delete","name":"Delete ProcessOutput","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ProcessOutput","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"outputId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true},{"name":"processId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"outputId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"},{"name":"processId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","429","500"],"pointer":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","href":"processes/processoutputs_delete","openApiOperationId":"ProcessOutputs_delete","summary":"Delete ProcessOutput"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"There is no content to send for this request, but the headers may be useful. "},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1processes~1{processId}~1outputs~1{outputId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/processes/processoutputs_delete"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}"}],"content":{"contentType":"group","meta":{"name":"Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes","showPageActions":true},{"nodeType":"markdoc","content":"Apis related to Processes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/processes","summary":"Create Process","prefix":{"name":"post","color":"post"},"badges":[{"name":"UDID","color":"#0ca272"}],"link":"/processes/processes_post","deprecated":false},{"title":"/organisations/{orgId}/processes","summary":"Retrieve Process List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processes_list","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}","summary":"Retrieve Process","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processes_read","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}","summary":"Update Process","prefix":{"name":"put","color":"put"},"badges":[],"link":"/processes/processes_update","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}","summary":"Delete Process","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/processes/processes_delete","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/inputs","summary":"Create ProcessInput","prefix":{"name":"post","color":"post"},"badges":[],"link":"/processes/processinputs_post","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/inputs","summary":"Retrieve ProcessInput List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processinputs_list","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","summary":"Retrieve ProcessInput","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processinputs_read","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","summary":"Update ProcessInput","prefix":{"name":"put","color":"put"},"badges":[],"link":"/processes/processinputs_update","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/inputs/{inputId}","summary":"Delete ProcessInput","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/processes/processinputs_delete","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/outputs","summary":"Create ProcessOutput","prefix":{"name":"post","color":"post"},"badges":[],"link":"/processes/processoutputs_post","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/outputs","summary":"Retrieve ProcessOutput List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processoutputs_list","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","summary":"Retrieve ProcessOutput","prefix":{"name":"get","color":"get"},"badges":[],"link":"/processes/processoutputs_read","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","summary":"Update ProcessOutput","prefix":{"name":"put","color":"put"},"badges":[],"link":"/processes/processoutputs_update","deprecated":false},{"title":"/organisations/{orgId}/processes/{processId}/outputs/{outputId}","summary":"Delete ProcessOutput","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/processes/processoutputs_delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Workflow","content":null},{"type":"group","label":"Delivery Workflow","link":"/reference/api/delivery-workflow","routeSlug":"/reference/api/delivery-workflow","items":[{"label":"Create Delivery from Inputs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/delivery-workflow/workflowdeliveries_post","routeSlug":"/reference/api/delivery-workflow/workflowdeliveries_post","metadata":{"seo":{"title":"Create Delivery from Inputs","description":"This allows for the creation of an 'outbound' delivery based on a variety of potential inputs and differing outputs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkflowDeliveries_post","name":"Create Delivery from Inputs","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1workflows~1deliveries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Delivery from Inputs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This allows for the creation of an 'outbound' delivery based on a variety of potential inputs and differing outputs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1deliveries/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1deliveries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48","pointer":"/paths/~1organisations~1{orgId}~1workflows~1deliveries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/workflows/deliveries","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_48"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/workflows/deliveries","href":"delivery-workflow/workflowdeliveries_post","openApiOperationId":"WorkflowDeliveries_post","summary":"Create Delivery from Inputs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.WorkflowResult"}},"schemaId":"components/schemas/Workflow.WorkflowResult","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1deliveries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Workflow.WorkflowResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.WorkflowResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-workflow/workflowdeliveries_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/workflows/deliveries"}],"content":{"contentType":"group","meta":{"name":"Delivery Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery Workflow","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/workflows/deliveries","summary":"Create Delivery from Inputs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery-workflow/workflowdeliveries_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Order Workflow","link":"/reference/api/order-workflow","routeSlug":"/reference/api/order-workflow","items":[{"label":"Create Purchase Order With Delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/order-workflow/workfloworders_post","routeSlug":"/reference/api/order-workflow/workfloworders_post","metadata":{"seo":{"title":"Create Purchase Order With Delivery","description":"This allows for the creation of a purchase order and a corresponding delivery as well as assigning DDS references."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkflowOrders_post","name":"Create Purchase Order With Delivery","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1workflows~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Purchase Order With Delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This allows for the creation of a purchase order and a corresponding delivery as well as assigning DDS references."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow.PurchaseOrderWorkflowRequest"}},"schemaId":"components/schemas/Workflow.PurchaseOrderWorkflowRequest","pointer":"/paths/~1organisations~1{orgId}~1workflows~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/workflows/orders","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Workflow.PurchaseOrderWorkflowRequest"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/workflows/orders","href":"order-workflow/workfloworders_post","openApiOperationId":"WorkflowOrders_post","summary":"Create Purchase Order With Delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/Workflow.PurchaseOrderWorkflowRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Workflow.PurchaseOrderWorkflowRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.POWorkflowResult"}},"schemaId":"components/schemas/Workflow.POWorkflowResult","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Workflow.POWorkflowResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.POWorkflowResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-workflow/workfloworders_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/workflows/orders"}],"content":{"contentType":"group","meta":{"name":"Order Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Workflow","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/workflows/orders","summary":"Create Purchase Order With Delivery","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-workflow/workfloworders_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Process workflow","link":"/reference/api/process-workflow","routeSlug":"/reference/api/process-workflow","items":[{"label":"Create Process from Inputs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/process-workflow/workflowprocessservice_post","routeSlug":"/reference/api/process-workflow/workflowprocessservice_post","metadata":{"seo":{"title":"Create Process from Inputs","description":"This allows for the creation of an process based on a variety of potential inputs and differing outputs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkflowProcessService_post","name":"Create Process from Inputs","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1workflows~1processes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Process from Inputs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This allows for the creation of an process based on a variety of potential inputs and differing outputs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1processes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1processes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49","pointer":"/paths/~1organisations~1{orgId}~1workflows~1processes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/workflows/processes","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_49"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/workflows/processes","href":"process-workflow/workflowprocessservice_post","openApiOperationId":"WorkflowProcessService_post","summary":"Create Process from Inputs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.ProcessWorkflowResult"}},"schemaId":"components/schemas/Workflow.ProcessWorkflowResult","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1workflows~1processes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Workflow.ProcessWorkflowResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Workflow.ProcessWorkflowResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/process-workflow/workflowprocessservice_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/workflows/processes"}],"content":{"contentType":"group","meta":{"name":"Process workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process workflow","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/workflows/processes","summary":"Create Process from Inputs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/process-workflow/workflowprocessservice_post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Reports","content":null},{"type":"separator","label":"Sending","content":null},{"type":"group","label":"Sending Outbound","link":"/reference/api/sending-outbound","routeSlug":"/reference/api/sending-outbound","items":[{"label":"Send Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/sending-outbound/sendservice_post","routeSlug":"/reference/api/sending-outbound/sendservice_post","metadata":{"seo":{"title":"Send Record","description":"Send a record to a counterparty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendService_post","name":"Send Record","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a record to a counterparty."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"contentType","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecordRequest"}},"schemaId":"components/schemas/OutboundSends.SendRecordRequest","pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations/{orgId}/record-sharing/outbound/shares","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"contentType","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecordRequest"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/organisations/{orgId}/record-sharing/outbound/shares","href":"sending-outbound/sendservice_post","openApiOperationId":"SendService_post","summary":"Send Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"schemaId":"components/schemas/OutboundSends.SendRecordRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecordRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecord"}},"schemaId":"components/schemas/OutboundSends.SendRecord","headers":{"Location":{"required":false,"description":"Location of the created resource","schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"400","description":"The server could not understand the request due to invalid syntax."},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OutboundSends.SendRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecord"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-outbound/sendservice_post"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/record-sharing/outbound/shares"},{"label":"Retrieve Send Record List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/sending-outbound/sendservice_list","routeSlug":"/reference/api/sending-outbound/sendservice_list","metadata":{"seo":{"title":"Retrieve Send Record List","description":"Retrieve Send Record List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendService_list","name":"Retrieve Send Record List","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Send Record List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"receiverUri","in":"query","explode":false,"schemaId":"schema_0","description":"The receiver Uri."},{"name":"rootRecordUri","in":"query","explode":false,"schemaId":"schema_0","description":"The root record to search for."},{"name":"recordUris","in":"query","explode":false,"schemaId":"schema_6","description":"Filter by specific record URIs."}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/record-sharing/outbound/shares","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"receiverUri","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"rootRecordUri","in":"query","required":false,"schemaId":"schema_0","explode":false},{"name":"recordUris","in":"query","required":false,"schemaId":"schema_6","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/organisations/{orgId}/record-sharing/outbound/shares","href":"sending-outbound/sendservice_list","openApiOperationId":"SendService_list","summary":"Retrieve Send Record List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-outbound/sendservice_list"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/record-sharing/outbound/shares"},{"label":"Retrieve Send Record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/api/sending-outbound/sendservice_read","routeSlug":"/reference/api/sending-outbound/sendservice_read","metadata":{"seo":{"title":"Retrieve Send Record","description":"Send a record to a counterparty."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SendService_read","name":"Retrieve Send Record","isWebhook":false,"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares~1{outboundShareId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Send Record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a record to a counterparty."},{"nodeType":"security","requirements":[{"schemes":[{"name":"InteruAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"outboundShareId","in":"path","schemaId":"schema_0","required":true},{"name":"orgId","in":"path","schemaId":"schema_0","description":"The organisation identity","required":true}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares~1{outboundShareId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{orgId}/record-sharing/outbound/shares/{outboundShareId}","servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"parameters":{"path":[{"name":"outboundShareId","in":"path","required":true,"schemaId":"schema_0"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"InteruAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/organisations/{orgId}/record-sharing/outbound/shares/{outboundShareId}","href":"sending-outbound/sendservice_read","openApiOperationId":"SendService_read","summary":"Retrieve Send Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/api","description":"Mock server","isMockServer":true},{"url":"https://api.uat.interu.io","description":"UAT"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request has succeeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecord"}},"schemaId":"components/schemas/OutboundSends.SendRecord"},{"code":"401","description":"Access is unauthorized."},{"code":"403","description":"Access is forbidden."},{"code":"404","description":"The server cannot find the requested resource."},{"code":"429","description":"Too many requests, wait and try again."},{"code":"500","description":"Server error"}],"pointer":"/paths/~1organisations~1{orgId}~1record-sharing~1outbound~1shares~1{outboundShareId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutboundSends.SendRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundSends.SendRecord"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-outbound/sendservice_read"}],"panels":[]}]},"httpPath":"/organisations/{orgId}/record-sharing/outbound/shares/{outboundShareId}"}],"content":{"contentType":"group","meta":{"name":"Sending Outbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sending Outbound","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations/{orgId}/record-sharing/outbound/shares","summary":"Send Record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sending-outbound/sendservice_post","deprecated":false},{"title":"/organisations/{orgId}/record-sharing/outbound/shares","summary":"Retrieve Send Record List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-outbound/sendservice_list","deprecated":false},{"title":"/organisations/{orgId}/record-sharing/outbound/shares/{outboundShareId}","summary":"Retrieve Send Record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-outbound/sendservice_read","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["country"],"properties":{"street":{"type":"string","description":"The mainline of the address."},"region":{"type":"string","description":"Region of the address."},"zipCode":{"type":"string","description":"Zip/postal code for the address."},"country":{"allOf":[{"$ref":"#/components/schemas/Shared.CountryCode"}],"description":"Alpha-2 code of the ISO 3166 Country Codes specification."}},"description":"A representation of a physical address."}},"components/schemas/AddressUpdate":{"id":"components/schemas/AddressUpdate","kind":"json-schema","title":"AddressUpdate","data":{"type":"object","properties":{"street":{"type":"string","description":"The mainline of the address."},"region":{"type":"string","description":"Region of the address."},"zipCode":{"type":"string","description":"Zip/postal code for the address."},"country":{"allOf":[{"$ref":"#/components/schemas/Shared.CountryCode"}],"description":"Alpha-2 code of the ISO 3166 Country Codes specification."}},"description":"A representation of a physical address."}},"components/schemas/Assessment.FailingRiskAssessment":{"id":"components/schemas/Assessment.FailingRiskAssessment","kind":"json-schema","title":"Assessment.FailingRiskAssessment","data":{"type":"object","required":["recordUri","recordName","reason"],"properties":{"recordUri":{"type":"string","format":"uri","description":"The URI of the record that does not have a valid Risk Assessment","examples":["/organisations{orgId}/locations/{locationId}"]},"recordName":{"type":"string","description":"Contains a user friendly identifier to help recognise the record that has the invalid risk assessment. (Location - Name, Organisation - Name, Country - Name, Material - Name, Deliveries - Delivery ID)"},"reason":{"allOf":[{"$ref":"#/components/schemas/Assessment.FailingRiskAssessmentReason"}],"description":"Gives the reason for the failure."}}}},"components/schemas/Assessment.FailingRiskAssessmentReason":{"id":"components/schemas/Assessment.FailingRiskAssessmentReason","kind":"json-schema","title":"Assessment.FailingRiskAssessmentReason","data":{"type":"string","enum":["EXPIRED","MISSING","UNACCEPTABLE_RISK"]}},"components/schemas/Assessment.RiskAssessmentType":{"id":"components/schemas/Assessment.RiskAssessmentType","kind":"json-schema","title":"Assessment.RiskAssessmentType","data":{"type":"string","enum":["COUNTRY","DELIVERY","LOCATION","MATERIAL","ORGANISTION","PRODUCT"]}},"components/schemas/Assessment.ValidationPath":{"id":"components/schemas/Assessment.ValidationPath","kind":"json-schema","title":"Assessment.ValidationPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Assessment.ValidationRequest":{"id":"components/schemas/Assessment.ValidationRequest","kind":"json-schema","title":"Assessment.ValidationRequest","data":{"type":"object","required":["records","includeRulesets"],"properties":{"records":{"type":"array","items":{"type":"string"},"description":"List of record URIs that you want to confirm are valid based on provided Criteria."},"includeRulesets":{"type":"boolean","description":"List of criteria to apply for validation."},"includedRiskAssessments":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.RiskAssessmentType"},"description":"If Risk Assessments are included in Criteria, this allows definition of which types of Risk Assessment are included in the check. If not included then risk assessments will be ignored."},"treatMissingAsError":{"type":"boolean","description":"If this is set to true then if a risk assessment is missing (or has expired - effectively missing) then it will cause validation to fail.","default":false}},"description":"The criteria used to validate records within Interu."}},"components/schemas/Assessment.ValidationResult":{"id":"components/schemas/Assessment.ValidationResult","kind":"json-schema","title":"Assessment.ValidationResult","data":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.ValidationStatus"},"description":"List of records that have been evaluated."}},"description":"Contains the validation status of each record that was requested."}},"components/schemas/Assessment.ValidationStatus":{"id":"components/schemas/Assessment.ValidationStatus","kind":"json-schema","title":"Assessment.ValidationStatus","data":{"type":"object","required":["recordUri","validated"],"properties":{"recordUri":{"type":"string","format":"uri","description":"URI of the record whose status you want to confirm","examples":["/organisations{orgId}/deliveries/{deliveryId}"]},"validated":{"type":"boolean","description":"The validation status. If true it means that the record passes the provided Criteria."},"failingRulesets":{"type":"array","items":{"type":"string"},"description":"If rulesets applicable to the record have not validated, this returns the name of the rulesets that have failed."},"failingRiskAssessments":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.FailingRiskAssessment"},"description":"If Risk Assessments were included in the request then this contains the list of risk assessment types that have not passed the validation."}}}},"components/schemas/Attachment.Attachment":{"id":"components/schemas/Attachment.Attachment","kind":"json-schema","title":"Attachment.Attachment","data":{"type":"object","required":["targetUri","attachmentUri"],"properties":{"targetUri":{"type":"string","description":"The resource that is being attached to.","examples":["/organisations/{orgId}/...path-to-record"]},"attachmentUri":{"type":"string","format":"uri","description":"The resource that is being attached.","examples":["/organisations/{orgId}/...path-to-record"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This provides the ability to 'attach' resources to other resources. This is to allow the association of items without actually changing the target items content thus rendering claims & endorsements invalid."},"children":[]}]}]}]}},"components/schemas/Attachment.AttachmentCreate":{"id":"components/schemas/Attachment.AttachmentCreate","kind":"json-schema","title":"Attachment.AttachmentCreate","data":{"type":"object","required":["targetUri","attachmentUri"],"properties":{"targetUri":{"type":"string","description":"The resource that is being attached to.","examples":["/organisations/{orgId}/...path-to-record"]},"attachmentUri":{"type":"string","format":"uri","description":"The resource that is being attached.","examples":["/organisations/{orgId}/...path-to-record"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This provides the ability to 'attach' resources to other resources. This is to allow the association of items without actually changing the target items content thus rendering claims & endorsements invalid."},"children":[]}]}]}]}},"components/schemas/Attachment.AttachmentCreateOrUpdate":{"id":"components/schemas/Attachment.AttachmentCreateOrUpdate","kind":"json-schema","title":"Attachment.AttachmentCreateOrUpdate","data":{"type":"object","required":["targetUri","attachmentUri"],"properties":{"targetUri":{"type":"string","description":"The resource that is being attached to.","examples":["/organisations/{orgId}/...path-to-record"]},"attachmentUri":{"type":"string","format":"uri","description":"The resource that is being attached.","examples":["/organisations/{orgId}/...path-to-record"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This provides the ability to 'attach' resources to other resources. This is to allow the association of items without actually changing the target items content thus rendering claims & endorsements invalid."},"children":[]}]}]}]}},"components/schemas/Attachment.AttachmentPath":{"id":"components/schemas/Attachment.AttachmentPath","kind":"json-schema","title":"Attachment.AttachmentPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Attachment.AttachmentPathRecord":{"id":"components/schemas/Attachment.AttachmentPathRecord","kind":"json-schema","title":"Attachment.AttachmentPathRecord","data":{"type":"object","required":["attachmentId"],"properties":{"attachmentId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Attachment.AttachmentPath"}]}},"components/schemas/Attachment.QueryAttachmentType":{"id":"components/schemas/Attachment.QueryAttachmentType","kind":"json-schema","title":"Attachment.QueryAttachmentType","data":{"type":"string","enum":["DOCUMENT"]}},"components/schemas/Attachment.QueryTargetType":{"id":"components/schemas/Attachment.QueryTargetType","kind":"json-schema","title":"Attachment.QueryTargetType","data":{"type":"string","enum":["CERTIFICATE","CONNECTION","COUNTRY","DELIVERY","ITEM","LOCATION","MATERIAL","ORGANISATION","PROCESS","PRODUCT"]}},"components/schemas/Common.Base":{"id":"components/schemas/Common.Base","kind":"json-schema","title":"Common.Base","data":{"type":"object","properties":{"createdBy":{"type":"string","description":"User who created the record."},"createdTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & Time that the record was created."},"children":[]}]}]}]},"updatedBy":{"type":"string","description":"Last updated by user."},"updatedTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & Time that the record was last updated."},"children":[]}]}]}]}}}},"components/schemas/Common.BaseCreate":{"id":"components/schemas/Common.BaseCreate","kind":"json-schema","title":"Common.BaseCreate","data":{"type":"object"}},"components/schemas/Common.BaseCreateOrUpdate":{"id":"components/schemas/Common.BaseCreateOrUpdate","kind":"json-schema","title":"Common.BaseCreateOrUpdate","data":{"type":"object"}},"components/schemas/Common.BaseUnit":{"id":"components/schemas/Common.BaseUnit","kind":"json-schema","title":"Common.BaseUnit","data":{"type":"object","required":["name","symbol","precision","type"],"properties":{"id":{"type":"string","description":"System assigned id field."},"name":{"type":"string","description":"The name of the base unit."},"symbol":{"type":"string","description":"The display symbol for the base unit."},"precision":{"type":"integer","description":"The precision required for the base unit."},"type":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.BaseUnitType"}],"description":"The type of the base unit of measurement."}},"description":"The extended definition of a base unit of measurement."}},"components/schemas/Common.BaseUnitPath":{"id":"components/schemas/Common.BaseUnitPath","kind":"json-schema","title":"Common.BaseUnitPath","data":{"type":"object"}},"components/schemas/Common.BaseUnitPathRecord":{"id":"components/schemas/Common.BaseUnitPathRecord","kind":"json-schema","title":"Common.BaseUnitPathRecord","data":{"type":"object","required":["unitId"],"properties":{"unitId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Common.BaseUnitPath"}]}},"components/schemas/Common.BaseUnitType":{"id":"components/schemas/Common.BaseUnitType","kind":"json-schema","title":"Common.BaseUnitType","data":{"type":"string","enum":["VOLUME","MASS","AREA","LENGTH","UNITS"]}},"components/schemas/Common.BaseWithId":{"id":"components/schemas/Common.BaseWithId","kind":"json-schema","title":"Common.BaseWithId","data":{"type":"object","properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}]}},"components/schemas/Common.BaseWithIdCreate":{"id":"components/schemas/Common.BaseWithIdCreate","kind":"json-schema","title":"Common.BaseWithIdCreate","data":{"type":"object","properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}]}},"components/schemas/Common.BaseWithIdCreateOrUpdate":{"id":"components/schemas/Common.BaseWithIdCreateOrUpdate","kind":"json-schema","title":"Common.BaseWithIdCreateOrUpdate","data":{"type":"object","properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}]}},"components/schemas/Common.BaseWithoutId":{"id":"components/schemas/Common.BaseWithoutId","kind":"json-schema","title":"Common.BaseWithoutId","data":{"type":"object","properties":{"id":{"type":"string","description":"System assigned id field."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}]}},"components/schemas/Common.BaseWithoutIdCreate":{"id":"components/schemas/Common.BaseWithoutIdCreate","kind":"json-schema","title":"Common.BaseWithoutIdCreate","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}]}},"components/schemas/Common.BaseWithoutIdCreateOrUpdate":{"id":"components/schemas/Common.BaseWithoutIdCreateOrUpdate","kind":"json-schema","title":"Common.BaseWithoutIdCreateOrUpdate","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}]}},"components/schemas/Common.CountriesPath":{"id":"components/schemas/Common.CountriesPath","kind":"json-schema","title":"Common.CountriesPath","data":{"type":"object"}},"components/schemas/Common.Enums.BaseUnitType":{"id":"components/schemas/Common.Enums.BaseUnitType","kind":"json-schema","title":"Common.Enums.BaseUnitType","data":{"type":"string","enum":["VOLUME","MASS","AREA","LENGTH","UNITS"]}},"components/schemas/Common.Enums.CustomFieldType":{"id":"components/schemas/Common.Enums.CustomFieldType","kind":"json-schema","title":"Common.Enums.CustomFieldType","data":{"type":"string","enum":["TEXT"]}},"components/schemas/Common.Enums.RecordState":{"id":"components/schemas/Common.Enums.RecordState","kind":"json-schema","title":"Common.Enums.RecordState","data":{"type":"string","enum":["ACTIVE","ARCHIVED"]}},"components/schemas/Common.Enums.SortType":{"id":"components/schemas/Common.Enums.SortType","kind":"json-schema","title":"Common.Enums.SortType","data":{"type":"string","enum":["asc","desc"]}},"components/schemas/Common.Enums.TagColor":{"id":"components/schemas/Common.Enums.TagColor","kind":"json-schema","title":"Common.Enums.TagColor","data":{"type":"string","enum":["LIGHT_GREY","GREY","ORANGE","YELLOW","RED","GREEN","PURPLE","BLUE"]}},"components/schemas/Common.Fields.created":{"id":"components/schemas/Common.Fields.created","kind":"json-schema","title":"Common.Fields.created","data":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"System assigned created DateTime."}}}},"components/schemas/Common.Fields.createdBy":{"id":"components/schemas/Common.Fields.createdBy","kind":"json-schema","title":"Common.Fields.createdBy","data":{"type":"object","properties":{"createdBy":{"type":"string","description":"System assigned user who created the record."}}}},"components/schemas/Common.Fields.createdTime":{"id":"components/schemas/Common.Fields.createdTime","kind":"json-schema","title":"Common.Fields.createdTime","data":{"type":"object","properties":{"createdTime":{"type":"string","format":"date-time","description":"System assigned created DateTime."}}}},"components/schemas/Common.Fields.id":{"id":"components/schemas/Common.Fields.id","kind":"json-schema","title":"Common.Fields.id","data":{"type":"object","properties":{"id":{"type":"string","description":"System assigned id field."}}}},"components/schemas/Common.Fields.recordState":{"id":"components/schemas/Common.Fields.recordState","kind":"json-schema","title":"Common.Fields.recordState","data":{"type":"object","properties":{"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}}}},"components/schemas/Common.Fields.sid":{"id":"components/schemas/Common.Fields.sid","kind":"json-schema","title":"Common.Fields.sid","data":{"type":"object","properties":{"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}}}},"components/schemas/Common.Fields.when":{"id":"components/schemas/Common.Fields.when","kind":"json-schema","title":"Common.Fields.when","data":{"type":"object","properties":{"when":{"type":"string","format":"date-time","description":"System assigned created DateTime."}}}},"components/schemas/Common.Paging.Page":{"id":"components/schemas/Common.Paging.Page","kind":"json-schema","title":"Common.Paging.Page","data":{"type":"object","required":["size","page","totalElements","totalPages"],"properties":{"size":{"type":"integer","format":"int32","description":"The number of elements on the given page."},"page":{"type":"integer","format":"int32","description":"The page No (zero based)."},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}},"components/schemas/Common.Standard":{"id":"components/schemas/Common.Standard","kind":"json-schema","title":"Common.Standard","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"System assigned id field."},"name":{"type":"string","description":"Full name of the standard."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}],"description":"Certification standard record."}},"components/schemas/Common.StandardCreate":{"id":"components/schemas/Common.StandardCreate","kind":"json-schema","title":"Common.StandardCreate","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Full name of the standard."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}],"description":"Certification standard record."}},"components/schemas/Common.StandardCreateOrUpdate":{"id":"components/schemas/Common.StandardCreateOrUpdate","kind":"json-schema","title":"Common.StandardCreateOrUpdate","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Full name of the standard."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}],"description":"Certification standard record."}},"components/schemas/Common.StandardPath":{"id":"components/schemas/Common.StandardPath","kind":"json-schema","title":"Common.StandardPath","data":{"type":"object"}},"components/schemas/Common.StandardPathRecord":{"id":"components/schemas/Common.StandardPathRecord","kind":"json-schema","title":"Common.StandardPathRecord","data":{"type":"object","required":["standardId"],"properties":{"standardId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Common.StandardPath"}]}},"components/schemas/Common.StandardType":{"id":"components/schemas/Common.StandardType","kind":"json-schema","title":"Common.StandardType","data":{"type":"object","required":["fullName","shortName"],"properties":{"id":{"type":"string","description":"System assigned id field."},"fullName":{"type":"string","description":"Full name of the standard type."},"shortName":{"type":"string","description":"Shortened name of the standard type."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}],"description":"This is a definition of a standard type"}},"components/schemas/Common.StandardTypeCreate":{"id":"components/schemas/Common.StandardTypeCreate","kind":"json-schema","title":"Common.StandardTypeCreate","data":{"type":"object","required":["fullName","shortName"],"properties":{"fullName":{"type":"string","description":"Full name of the standard type."},"shortName":{"type":"string","description":"Shortened name of the standard type."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}],"description":"This is a definition of a standard type"}},"components/schemas/Common.StandardTypeCreateOrUpdate":{"id":"components/schemas/Common.StandardTypeCreateOrUpdate","kind":"json-schema","title":"Common.StandardTypeCreateOrUpdate","data":{"type":"object","required":["fullName","shortName"],"properties":{"fullName":{"type":"string","description":"Full name of the standard type."},"shortName":{"type":"string","description":"Shortened name of the standard type."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}],"description":"This is a definition of a standard type"}},"components/schemas/Config.DocumentType":{"id":"components/schemas/Config.DocumentType","kind":"json-schema","title":"Config.DocumentType","data":{"type":"object","required":["name","private"],"properties":{"name":{"type":"string","description":"The name of the Document Type."},"private":{"type":"boolean","description":"Determines if documents with this type are to be shared externally or not."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"Represents the type of a document."}},"components/schemas/Config.DocumentTypeCreate":{"id":"components/schemas/Config.DocumentTypeCreate","kind":"json-schema","title":"Config.DocumentTypeCreate","data":{"type":"object","required":["name","private"],"properties":{"name":{"type":"string","description":"The name of the Document Type."},"private":{"type":"boolean","description":"Determines if documents with this type are to be shared externally or not."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"Represents the type of a document."}},"components/schemas/Config.DocumentTypeCreateOrUpdate":{"id":"components/schemas/Config.DocumentTypeCreateOrUpdate","kind":"json-schema","title":"Config.DocumentTypeCreateOrUpdate","data":{"type":"object","required":["name","private"],"properties":{"name":{"type":"string","description":"The name of the Document Type."},"private":{"type":"boolean","description":"Determines if documents with this type are to be shared externally or not."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"Represents the type of a document."}},"components/schemas/Config.DocumentTypePath":{"id":"components/schemas/Config.DocumentTypePath","kind":"json-schema","title":"Config.DocumentTypePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Config.DocumentTypePathRecord":{"id":"components/schemas/Config.DocumentTypePathRecord","kind":"json-schema","title":"Config.DocumentTypePathRecord","data":{"type":"object","required":["documentTypeId"],"properties":{"documentTypeId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Config.DocumentTypePath"}]}},"components/schemas/Config.DocumentTypeUpdate":{"id":"components/schemas/Config.DocumentTypeUpdate","kind":"json-schema","title":"Config.DocumentTypeUpdate","data":{"type":"object","required":["name","private"],"properties":{"name":{"type":"string","description":"The name of the Document Type."},"private":{"type":"boolean","description":"Determines if documents with this type are to be shared externally or not."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Config.LocationType":{"id":"components/schemas/Config.LocationType","kind":"json-schema","title":"Config.LocationType","data":{"type":"object","required":["type","pointOfOrigin"],"properties":{"type":{"type":"string","description":"The name for the location type."},"pointOfOrigin":{"type":"boolean","description":"Defines if this location type is a Point of Origin."},"downstream":{"type":"boolean","description":"Defines if this location type represents a downstream location."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"Represents the type of a location."}},"components/schemas/Config.LocationTypeCreate":{"id":"components/schemas/Config.LocationTypeCreate","kind":"json-schema","title":"Config.LocationTypeCreate","data":{"type":"object","required":["type","pointOfOrigin"],"properties":{"type":{"type":"string","description":"The name for the location type."},"pointOfOrigin":{"type":"boolean","description":"Defines if this location type is a Point of Origin."},"downstream":{"type":"boolean","description":"Defines if this location type represents a downstream location."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"Represents the type of a location."}},"components/schemas/Config.LocationTypeCreateOrUpdate":{"id":"components/schemas/Config.LocationTypeCreateOrUpdate","kind":"json-schema","title":"Config.LocationTypeCreateOrUpdate","data":{"type":"object","required":["type","pointOfOrigin"],"properties":{"type":{"type":"string","description":"The name for the location type."},"pointOfOrigin":{"type":"boolean","description":"Defines if this location type is a Point of Origin."},"downstream":{"type":"boolean","description":"Defines if this location type represents a downstream location."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"Represents the type of a location."}},"components/schemas/Config.LocationTypePath":{"id":"components/schemas/Config.LocationTypePath","kind":"json-schema","title":"Config.LocationTypePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Config.LocationTypePathRecord":{"id":"components/schemas/Config.LocationTypePathRecord","kind":"json-schema","title":"Config.LocationTypePathRecord","data":{"type":"object","required":["locTypeId"],"properties":{"locTypeId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Config.LocationTypePath"}]}},"components/schemas/Config.LocationTypeUpdate":{"id":"components/schemas/Config.LocationTypeUpdate","kind":"json-schema","title":"Config.LocationTypeUpdate","data":{"type":"object","required":["type","pointOfOrigin"],"properties":{"type":{"type":"string","description":"The name for the location type."},"pointOfOrigin":{"type":"boolean","description":"Defines if this location type is a Point of Origin."},"downstream":{"type":"boolean","description":"Defines if this location type represents a downstream location."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Config.ProcessType":{"id":"components/schemas/Config.ProcessType","kind":"json-schema","title":"Config.ProcessType","data":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"System or user assigned id field."},"name":{"type":"string","description":"The name for the process type."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}],"description":"Record that is used to define internal processes. These connect organisation 'inputs' to organisation 'outputs' thus completing the end-to-end traceability chain."}},"components/schemas/Config.ProcessTypeCreate":{"id":"components/schemas/Config.ProcessTypeCreate","kind":"json-schema","title":"Config.ProcessTypeCreate","data":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"System or user assigned id field."},"name":{"type":"string","description":"The name for the process type."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}],"description":"Record that is used to define internal processes. These connect organisation 'inputs' to organisation 'outputs' thus completing the end-to-end traceability chain."}},"components/schemas/Config.ProcessTypeCreateOrUpdate":{"id":"components/schemas/Config.ProcessTypeCreateOrUpdate","kind":"json-schema","title":"Config.ProcessTypeCreateOrUpdate","data":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"System or user assigned id field."},"name":{"type":"string","description":"The name for the process type."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}],"description":"Record that is used to define internal processes. These connect organisation 'inputs' to organisation 'outputs' thus completing the end-to-end traceability chain."}},"components/schemas/Config.ProcessTypePath":{"id":"components/schemas/Config.ProcessTypePath","kind":"json-schema","title":"Config.ProcessTypePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Config.ProcessTypePathRecord":{"id":"components/schemas/Config.ProcessTypePathRecord","kind":"json-schema","title":"Config.ProcessTypePathRecord","data":{"type":"object","required":["processTypeId"],"properties":{"processTypeId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Config.ProcessTypePath"}]}},"components/schemas/Config.ProcessTypeUpdate":{"id":"components/schemas/Config.ProcessTypeUpdate","kind":"json-schema","title":"Config.ProcessTypeUpdate","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name for the process type."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/CreateDDStatement":{"id":"components/schemas/CreateDDStatement","kind":"json-schema","title":"CreateDDStatement","data":{"type":"object","properties":{"operatorType":{"$ref":"#/components/schemas/Integrations.Eudr.OperatorType"},"activityType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ActivityType"}],"description":"The activity type."},"countryOfActivity":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity."},"borderCrossCountry":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is required for IMPORT or EXPORT activities."},"comment":{"type":"string"},"geoLocationConfidential":{"type":"boolean","description":"IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information."},"associatedStatements":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.AssociatedStatement"},"description":""},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Create_DDS_From_Other":{"id":"components/schemas/Create_DDS_From_Other","kind":"json-schema","title":"Create_DDS_From_Other","data":{"type":"object","required":["sourceResourceType","sourceUris"],"properties":{"sourceResourceType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.OtherSourceResourceType"}],"description":"This is the resource type of the source."},"sourceUris":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"This is the source uris to generate the DDS for.","examples":[["/organisations{orgId}/deliveries/{deliveryId}","/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/items/{itemId}"]]},"productionPlaceSource":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ProductionPlaceSource"}],"description":"The source of production place data.","readOnly":true},"suppliers":{"type":"array","items":{"type":"string"},"description":"The supplier URIs associated with this source data.","readOnly":true},"buyers":{"type":"array","items":{"type":"string"},"description":"The buyer URIs associated with this source data.","readOnly":true},"staticSupplyChainUris":{"type":"array","items":{"type":"string"},"description":"The static supply chain URIs associated with this source data.","readOnly":true}},"description":"Create a DDS from deliveries, purchase orders or items. Note you can only pick one source type."}},"components/schemas/Create_DDS_From_Products":{"id":"components/schemas/Create_DDS_From_Products","kind":"json-schema","title":"Create_DDS_From_Products","data":{"type":"object","required":["sourceResourceType","products"],"properties":{"sourceResourceType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ProductSourceResourceType"}],"description":"This is the resource type of the source. Note that for create a Product DDS this can only be PRODUCT"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ProductQuantity"},"maxItems":100,"description":"This is information on the products to generate a DDS for."},"productionPlaceSource":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ProductionPlaceSource"}],"description":"The source of production place data.","readOnly":true},"suppliers":{"type":"array","items":{"type":"string"},"description":"The supplier URIs associated with this source data.","readOnly":true},"buyers":{"type":"array","items":{"type":"string"},"description":"The buyer URIs associated with this source data.","readOnly":true},"staticSupplyChainUris":{"type":"array","items":{"type":"string"},"description":"The static supply chain URIs associated with this source data.","readOnly":true}},"description":"Create a DDS from a product. Requires the specification of a quantity to create."}},"components/schemas/Create_Process_From_Batches":{"id":"components/schemas/Create_Process_From_Batches","kind":"json-schema","title":"Create_Process_From_Batches","data":{"type":"object","allOf":[{"type":"object","required":["processLocation","lineItems"],"properties":{"processLocation":{"type":"string","format":"uri","description":"Specify delivery configuration if you wish to create a delivery","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.BatchInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a process."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be associated with the PO and (if specified) the created delivery."}}}],"description":"Supports the creation of a process with input items that are selected by a batch number."}},"components/schemas/Create_Process_From_Items":{"id":"components/schemas/Create_Process_From_Items","kind":"json-schema","title":"Create_Process_From_Items","data":{"type":"object","allOf":[{"type":"object","required":["processLocation","lineItems"],"properties":{"processLocation":{"type":"string","format":"uri","description":"Specify delivery configuration if you wish to create a delivery","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemsInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a process."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be associated with the PO and (if specified) the created delivery."}}}],"description":"Supports the creation of a process with input items that are selected directly from provided input items."}},"components/schemas/Create_Process_From_Products":{"id":"components/schemas/Create_Process_From_Products","kind":"json-schema","title":"Create_Process_From_Products","data":{"type":"object","allOf":[{"type":"object","required":["processLocation","lineItems"],"properties":{"processLocation":{"type":"string","format":"uri","description":"Specify delivery configuration if you wish to create a delivery","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a process."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be associated with the PO and (if specified) the created delivery."}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports the creation of a process with input items that are selected based on a Product and a selection strategy (FIFO|LIFO)"},"children":[]}]}]}]}},"components/schemas/Create_Production_Delivery_From_Batches":{"id":"components/schemas/Create_Production_Delivery_From_Batches","kind":"json-schema","title":"Create_Production_Delivery_From_Batches","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.BatchInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":"Supports the creation of a delivery with items that are selected by a batch number."}},"components/schemas/Create_Production_Delivery_From_Items":{"id":"components/schemas/Create_Production_Delivery_From_Items","kind":"json-schema","title":"Create_Production_Delivery_From_Items","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemsInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":"Supports the creation of a delivery with items that are selected directly from provided input items."}},"components/schemas/Create_Production_Delivery_From_Products":{"id":"components/schemas/Create_Production_Delivery_From_Products","kind":"json-schema","title":"Create_Production_Delivery_From_Products","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports the creation of a delivery with items that are selected based on a Product and a selection strategy (FIFO|LIFO)"},"children":[]}]}]}]}},"components/schemas/Create_Trade_Delivery_From_Batches":{"id":"components/schemas/Create_Trade_Delivery_From_Batches","kind":"json-schema","title":"Create_Trade_Delivery_From_Batches","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.BatchInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":"Supports the creation of a delivery with items that are selected by a batch number."}},"components/schemas/Create_Trade_Delivery_From_Items":{"id":"components/schemas/Create_Trade_Delivery_From_Items","kind":"json-schema","title":"Create_Trade_Delivery_From_Items","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemsInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":"Supports the creation of a delivery with items that are selected directly from provided input items."}},"components/schemas/Create_Trade_Delivery_From_Products":{"id":"components/schemas/Create_Trade_Delivery_From_Products","kind":"json-schema","title":"Create_Trade_Delivery_From_Products","data":{"type":"object","allOf":[{"type":"object","required":["deliveryId","from","to","status","lineItems"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"List of purchase order numbers that you want to associate with the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of organisations that act as agents for the delivery.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"lineItems":{"type":"array","items":{"type":"object","required":["inputs","outputs","processType"],"properties":{"supplier":{"type":"string","format":"uri","description":"This is the supplier of the items that are to be used as input items and is required if you are utilising Predictive DDS.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"inputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ProductInput"},"description":"Identifies the input items to use in creating the outbound delivery."},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.ItemOutput"},"description":"Identifies details of the output items to be created in the outbound delivery."},"inputDate":{"type":"string","format":"date-time","description":"The input date for the created process."},"outputDate":{"type":"string","format":"date-time","description":"The output date for the created process."},"processType":{"type":"string","format":"uri","description":"The URI of the Process Type that represents the task of linking inbound to outbound.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]}}},"description":"The line item definitions for the inputs and outputs for a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be created or associated with the delivery."}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports the creation of a delivery with items that are selected based on a Product and a selection strategy (FIFO|LIFO)"},"children":[]}]}]}]}},"components/schemas/DateOrRange":{"id":"components/schemas/DateOrRange","kind":"json-schema","title":"DateOrRange","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXACT","RANGE"],"description":"The type of captured date."},"on":{"type":"string","format":"date-time","description":"If Type is EXACT then this precise date is used."},"start":{"type":"string","format":"date-time","description":"If type is RANGE then this is the start date."},"end":{"type":"string","format":"date-time","description":"If type is RANGE then this is the end date."}}}},"components/schemas/Evidence.Document":{"id":"components/schemas/Evidence.Document","kind":"json-schema","title":"Evidence.Document","data":{"type":"object","required":["name","type","issuance","validityStart","validityEnd","contentType","contentHash","originalHash","contentSize","private"],"properties":{"name":{"type":"string","description":"The name of the document. This must be unique."},"type":{"type":"string","format":"uri","description":"The URI to the type of document.","examples":["/organisations/{orgId}/document-types/{documentTypeId}"]},"issuance":{"type":"string","format":"date-time","description":"The date and time when this document was issued."},"validityStart":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it starts."},"validityEnd":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it ends."},"contentType":{"type":"string","description":"The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)"},"contentHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided."},"originalHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided."},"contentSize":{"type":"integer","format":"int32","description":"The size of the file in bytes."},"private":{"type":"boolean","description":"If set to true, the document will not be shared."},"types":{"type":"array","items":{"type":"string"},"description":"The URIs of the types of document. Use this when a document has more than one type.","examples":[["/organisations/{orgId}/document-types/{documentTypeId}"]]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":"A document represents evidence that can be attached to resources such as items, deliveries, and processes."}},"components/schemas/Evidence.DocumentCreate":{"id":"components/schemas/Evidence.DocumentCreate","kind":"json-schema","title":"Evidence.DocumentCreate","data":{"type":"object","required":["name","type","issuance","validityStart","validityEnd","contentType","contentHash","originalHash","contentSize","private"],"properties":{"name":{"type":"string","description":"The name of the document. This must be unique."},"type":{"type":"string","format":"uri","description":"The URI to the type of document.","examples":["/organisations/{orgId}/document-types/{documentTypeId}"]},"issuance":{"type":"string","format":"date-time","description":"The date and time when this document was issued."},"validityStart":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it starts."},"validityEnd":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it ends."},"contentType":{"type":"string","description":"The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)"},"contentHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided."},"originalHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided."},"contentSize":{"type":"integer","format":"int32","description":"The size of the file in bytes."},"private":{"type":"boolean","description":"If set to true, the document will not be shared."},"types":{"type":"array","items":{"type":"string"},"description":"The URIs of the types of document. Use this when a document has more than one type.","examples":[["/organisations/{orgId}/document-types/{documentTypeId}"]]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":"A document represents evidence that can be attached to resources such as items, deliveries, and processes."}},"components/schemas/Evidence.DocumentCreateOrUpdate":{"id":"components/schemas/Evidence.DocumentCreateOrUpdate","kind":"json-schema","title":"Evidence.DocumentCreateOrUpdate","data":{"type":"object","required":["name","type","issuance","validityStart","validityEnd","contentType","contentHash","originalHash","contentSize","private"],"properties":{"name":{"type":"string","description":"The name of the document. This must be unique."},"type":{"type":"string","format":"uri","description":"The URI to the type of document.","examples":["/organisations/{orgId}/document-types/{documentTypeId}"]},"issuance":{"type":"string","format":"date-time","description":"The date and time when this document was issued."},"validityStart":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it starts."},"validityEnd":{"type":"string","format":"date-time","description":"If the document has a validity period, this is when it ends."},"contentType":{"type":"string","description":"The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)"},"contentHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided."},"originalHash":{"type":"string","description":"Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided."},"contentSize":{"type":"integer","format":"int32","description":"The size of the file in bytes."},"private":{"type":"boolean","description":"If set to true, the document will not be shared."},"types":{"type":"array","items":{"type":"string"},"description":"The URIs of the types of document. Use this when a document has more than one type.","examples":[["/organisations/{orgId}/document-types/{documentTypeId}"]]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":"A document represents evidence that can be attached to resources such as items, deliveries, and processes."}},"components/schemas/Evidence.DocumentPath":{"id":"components/schemas/Evidence.DocumentPath","kind":"json-schema","title":"Evidence.DocumentPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Evidence.DocumentPathRecord":{"id":"components/schemas/Evidence.DocumentPathRecord","kind":"json-schema","title":"Evidence.DocumentPathRecord","data":{"type":"object","required":["documentId"],"properties":{"documentId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Evidence.DocumentPath"}]}},"components/schemas/Integrations.Eudr.ActivityType":{"id":"components/schemas/Integrations.Eudr.ActivityType","kind":"json-schema","title":"Integrations.Eudr.ActivityType","data":{"type":"string","enum":["IMPORT","EXPORT","DOMESTIC"]}},"components/schemas/Integrations.Eudr.AssociatedStatement":{"id":"components/schemas/Integrations.Eudr.AssociatedStatement","kind":"json-schema","title":"Integrations.Eudr.AssociatedStatement","data":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"Associated Due Diligence Reference Number (DDRN)"},"verificationNumber":{"type":"string","description":"Associated Due Diligence Verification Number (DDVN)"}}}},"components/schemas/Integrations.Eudr.BalanceTracking":{"id":"components/schemas/Integrations.Eudr.BalanceTracking","kind":"json-schema","title":"Integrations.Eudr.BalanceTracking","data":{"type":"string","enum":["HS_CODE","PRODUCT"]}},"components/schemas/Integrations.Eudr.Commodity":{"id":"components/schemas/Integrations.Eudr.Commodity","kind":"json-schema","title":"Integrations.Eudr.Commodity","data":{"type":"object","required":["productUri","content"],"properties":{"productUri":{"type":"string","format":"uri","description":"This is the URI to the product that is relevant for the Due Diligence statement","examples":["/organisations/{orgId}/products/{productId}"]},"statedVolume":{"type":"number","format":"decimal","description":"Set to null to use generated volume"},"statedNetWeight":{"type":"number","format":"decimal","description":"Set to null to use generated net weight"},"content":{"$ref":"#/components/schemas/Integrations.Eudr.Content"}}}},"components/schemas/Integrations.Eudr.CommodityCreateOrUpdateItem":{"id":"components/schemas/Integrations.Eudr.CommodityCreateOrUpdateItem","kind":"json-schema","title":"Integrations.Eudr.CommodityCreateOrUpdateItem","data":{"type":"object","required":["productUri"],"properties":{"productUri":{"type":"string","format":"uri","description":"This is the URI to the product that is relevant for the Due Diligence statement","examples":["/organisations/{orgId}/products/{productId}"]},"statedVolume":{"type":"number","format":"decimal","description":"Set to null to use generated volume"},"statedNetWeight":{"type":"number","format":"decimal","description":"Set to null to use generated net weight"}}}},"components/schemas/Integrations.Eudr.CommodityUpdateItem":{"id":"components/schemas/Integrations.Eudr.CommodityUpdateItem","kind":"json-schema","title":"Integrations.Eudr.CommodityUpdateItem","data":{"type":"object","required":["productUri"],"properties":{"productUri":{"type":"string","format":"uri","description":"This is the URI to the product that is relevant for the Due Diligence statement","examples":["/organisations/{orgId}/products/{productId}"]},"statedVolume":{"type":"number","format":"decimal","description":"Set to null to use generated volume"},"statedNetWeight":{"type":"number","format":"decimal","description":"Set to null to use generated net weight"}}}},"components/schemas/Integrations.Eudr.Content":{"id":"components/schemas/Integrations.Eudr.Content","kind":"json-schema","title":"Integrations.Eudr.Content","data":{"type":"object","required":["producers"],"properties":{"volume":{"type":"number","format":"decimal"},"netWeight":{"type":"number","format":"decimal"},"hsHeading":{"type":"string"},"descriptionOfGoods":{"type":"string"},"speciesInfo":{"type":"array","items":{"$ref":"#/components/schemas/SpeciesInfo"}},"producers":{"type":"array","items":{"$ref":"#/components/schemas/Producer"}}}}},"components/schemas/Integrations.Eudr.CreateDDSReference":{"id":"components/schemas/Integrations.Eudr.CreateDDSReference","kind":"json-schema","title":"Integrations.Eudr.CreateDDSReference","data":{"type":"object","required":["type"],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.Type"}],"description":"This is the type of the DDS Reference. If you are generating a new DDS Reference then set this to NEW. If you are adding an existing Reference then set it to EXISTING."}},"discriminator":{"propertyName":"type","mapping":{"NEW":"#/components/schemas/Integrations.Eudr.CreateNewDDSReference","EXISTING":"#/components/schemas/Integrations.Eudr.CreateExistingDDSReference"}}}},"components/schemas/Integrations.Eudr.CreateExistingDDSReference":{"id":"components/schemas/Integrations.Eudr.CreateExistingDDSReference","kind":"json-schema","title":"Integrations.Eudr.CreateExistingDDSReference","data":{"type":"object","required":["type","operatorUri"],"properties":{"type":{"type":"string","enum":["EXISTING"],"description":"This is the type of the DDS Reference. If you are generating a new DDS Reference then set this to NEW."},"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement."},"operatorUri":{"type":"string","description":"This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT."}},"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.CreateDDSReference"}]}},"components/schemas/Integrations.Eudr.CreateNewDDSReference":{"id":"components/schemas/Integrations.Eudr.CreateNewDDSReference","kind":"json-schema","title":"Integrations.Eudr.CreateNewDDSReference","data":{"type":"object","required":["type","sourceData"],"properties":{"type":{"type":"string","enum":["NEW"],"description":"This is the type of the DDS Reference. If you are generating a new DDS Reference then set this to NEW."},"statementData":{"allOf":[{"$ref":"#/components/schemas/CreateDDStatement"}],"description":"If creating a NEW Due Diligence Statement then this field is required."},"sourceData":{"anyOf":[{"$ref":"#/components/schemas/Create_DDS_From_Products"},{"$ref":"#/components/schemas/Create_DDS_From_Other"}],"description":"The source data items to base the DDS Statement on."},"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."}},"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.CreateDDSReference"}]}},"components/schemas/Integrations.Eudr.Credential":{"id":"components/schemas/Integrations.Eudr.Credential","kind":"json-schema","title":"Integrations.Eudr.Credential","data":{"type":"object","properties":{"username":{"type":"string","description":"The Traces NT Username."},"authKey":{"type":"string","description":"Your Traces NT authentication key."},"operatorUri":{"type":"string","format":"uri","description":"The operator","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/"]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}]}},"components/schemas/Integrations.Eudr.CredentialCreate":{"id":"components/schemas/Integrations.Eudr.CredentialCreate","kind":"json-schema","title":"Integrations.Eudr.CredentialCreate","data":{"type":"object","properties":{"username":{"type":"string","description":"The Traces NT Username."},"authKey":{"type":"string","description":"Your Traces NT authentication key."},"operatorUri":{"type":"string","format":"uri","description":"The operator","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/"]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}]}},"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate":{"id":"components/schemas/Integrations.Eudr.CredentialCreateOrUpdate","kind":"json-schema","title":"Integrations.Eudr.CredentialCreateOrUpdate","data":{"type":"object","properties":{"username":{"type":"string","description":"The Traces NT Username."},"authKey":{"type":"string","description":"Your Traces NT authentication key."},"operatorUri":{"type":"string","format":"uri","description":"The operator","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/"]},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}]}},"components/schemas/Integrations.Eudr.CredentialQuery":{"id":"components/schemas/Integrations.Eudr.CredentialQuery","kind":"json-schema","title":"Integrations.Eudr.CredentialQuery","data":{"type":"object","properties":{"size":{"type":"integer","format":"int32","minimum":1,"description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20.","default":20},"page":{"type":"integer","format":"int32","minimum":0,"description":"The pageNo to return. (Zero-based)","default":0},"sort":{"type":"array","items":{"type":"string"},"description":"Sort criteria in the format property,direction (e.g. asc,desc)."}}}},"components/schemas/Integrations.Eudr.CredentialRecordPath":{"id":"components/schemas/Integrations.Eudr.CredentialRecordPath","kind":"json-schema","title":"Integrations.Eudr.CredentialRecordPath","data":{"type":"object","required":["credentialsId"],"properties":{"credentialsId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.CredentialsPath"}]}},"components/schemas/Integrations.Eudr.CredentialsPath":{"id":"components/schemas/Integrations.Eudr.CredentialsPath","kind":"json-schema","title":"Integrations.Eudr.CredentialsPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Integrations.Eudr.DDSRecord":{"id":"components/schemas/Integrations.Eudr.DDSRecord","kind":"json-schema","title":"Integrations.Eudr.DDSRecord","data":{"type":"object","required":["recordUri"],"properties":{"recordUri":{"type":"string","format":"uri","description":"This is the URI of the the record - i.e the Delivery or the Purchase Order.","examples":["/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/deliveries/{deliveryId}"]},"references":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.DDSReferenceDetail"},"description":"The found Due Diligence Statement References. This will only be present if References were found."}}}},"components/schemas/Integrations.Eudr.DDSReference":{"id":"components/schemas/Integrations.Eudr.DDSReference","kind":"json-schema","title":"Integrations.Eudr.DDSReference","data":{"type":"object","required":["operatorUri"],"properties":{"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement."},"hasStatement":{"type":"boolean","description":"True if there is a DDS Statement associated with this reference number. This happens if it is generated or if there is a Reference Number and Validation Number and the Statement can be retrieved from Traces."},"status":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.DDSStatus"}],"description":"The status of the Due Diligence Statement."},"operatorUri":{"type":"string","description":"This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT."},"balanceTracking":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.BalanceTracking"}],"description":"The balance tracking mode for this DDS Reference."},"relationToRecordType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.RelationToRecordType"}],"description":"Indicates whether this is a direct or indirect record relation."},"signature":{"type":"string","description":"The signature of the submitted DDS statement.","readOnly":true},"statementBalances":{"type":"object","unevaluatedProperties":{},"description":"The statement balances for this DDS Reference.","readOnly":true},"submittedBy":{"type":"string","description":"The user who submitted the DDS statement.","readOnly":true},"validityStart":{"type":"string","format":"date-time","description":"The validity start date of the DDS statement.","readOnly":true},"validityEnd":{"type":"string","format":"date-time","description":"The validity end date of the DDS statement.","readOnly":true},"withdrawable":{"type":"boolean","description":"True if the DDS statement associated with this reference is currently in a state that allows it to be withdrawn."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}]}},"components/schemas/Integrations.Eudr.DDSReferenceCreate":{"id":"components/schemas/Integrations.Eudr.DDSReferenceCreate","kind":"json-schema","title":"Integrations.Eudr.DDSReferenceCreate","data":{"type":"object","required":["operatorUri"],"properties":{"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement."},"operatorUri":{"type":"string","description":"This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}]}},"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate":{"id":"components/schemas/Integrations.Eudr.DDSReferenceCreateOrUpdate","kind":"json-schema","title":"Integrations.Eudr.DDSReferenceCreateOrUpdate","data":{"type":"object","required":["operatorUri"],"properties":{"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT. It is required if you want to reference the related DDS Statement in another DDS Statement."},"operatorUri":{"type":"string","description":"This is the url of the organisation or connection from which the credentials will be used for submission or retrieval of DDS Statements with Traces NT."},"balanceTracking":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.BalanceTracking"}],"description":"The balance tracking mode for this DDS Reference."},"validityPeriod":{"type":"object","unevaluatedProperties":{},"description":"The validity period for the DDS Reference. Contains startDate and endDate."},"suppliers":{"type":"array","items":{"type":"string"},"description":"The supplier URIs to associate with this DDS Reference.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]},"buyers":{"type":"array","items":{"type":"string"},"description":"The buyer URIs to associate with this DDS Reference.","examples":[["/organisations/{orgId}/connections/{connectionId}"]]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}]}},"components/schemas/Integrations.Eudr.DDSReferenceDetail":{"id":"components/schemas/Integrations.Eudr.DDSReferenceDetail","kind":"json-schema","title":"Integrations.Eudr.DDSReferenceDetail","data":{"type":"object","required":["id","hasStatement"],"properties":{"id":{"type":"string","description":"The id of the reference."},"internalReferenceNumber":{"type":"string","description":"An internal reference number provided by a user to help identify the DDS Reference."},"status":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.DDSStatus"}],"description":"The status of the Due Diligence Statement."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT."},"hasStatement":{"type":"boolean","description":"Whether or not this reference has a statement."}}}},"components/schemas/Integrations.Eudr.DDSReferenceDirectRecordsQuery":{"id":"components/schemas/Integrations.Eudr.DDSReferenceDirectRecordsQuery","kind":"json-schema","title":"Integrations.Eudr.DDSReferenceDirectRecordsQuery","data":{"type":"object","properties":{"size":{"type":"integer","format":"int32","minimum":1,"description":"The number of elements to return in each page. Minimum value must be 1, defaults to 20.","default":20},"page":{"type":"integer","format":"int32","minimum":0,"description":"The pageNo to return. (Zero-based)","default":0},"sort":{"type":"array","items":{"type":"string"},"description":"Sort criteria in the format property,direction (e.g. asc,desc)."}}}},"components/schemas/Integrations.Eudr.DDSReferencePath":{"id":"components/schemas/Integrations.Eudr.DDSReferencePath","kind":"json-schema","title":"Integrations.Eudr.DDSReferencePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Integrations.Eudr.DDSReferencePathRecordPath":{"id":"components/schemas/Integrations.Eudr.DDSReferencePathRecordPath","kind":"json-schema","title":"Integrations.Eudr.DDSReferencePathRecordPath","data":{"type":"object","required":["referenceId"],"properties":{"referenceId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.DDSReferencePath"}]}},"components/schemas/Integrations.Eudr.DDSStatus":{"id":"components/schemas/Integrations.Eudr.DDSStatus","kind":"json-schema","title":"Integrations.Eudr.DDSStatus","data":{"type":"string","enum":["PENDING","SUBMITTED","AVAILABLE","REJECTED","CANCELLED","WITHDRAWN","ARCHIVED","SUSPENDED","UPDATED","GROUPED","OBSOLETE"]}},"components/schemas/Integrations.Eudr.DDSUpdate":{"id":"components/schemas/Integrations.Eudr.DDSUpdate","kind":"json-schema","title":"Integrations.Eudr.DDSUpdate","data":{"type":"object","properties":{"countryOfActivity":{"$ref":"#/components/schemas/Shared.EuCountryCode"},"borderCrossCountry":{"$ref":"#/components/schemas/Shared.EuCountryCode"},"commodities":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.CommodityUpdateItem"}},"comment":{"type":"string"},"geoLocationConfidential":{"type":"boolean"},"associatedStatements":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.AssociatedStatement"}}},"description":"Updating a DDS statement is required if certain fields change."}},"components/schemas/Integrations.Eudr.DDStatement":{"id":"components/schemas/Integrations.Eudr.DDStatement","kind":"json-schema","title":"Integrations.Eudr.DDStatement","data":{"type":"object","required":["version"],"properties":{"version":{"type":"integer"},"operatorType":{"$ref":"#/components/schemas/Integrations.Eudr.OperatorType"},"activityType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ActivityType"}],"description":"The activity type."},"countryOfActivity":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity."},"borderCrossCountry":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is required for IMPORT or EXPORT activities."},"commodities":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.Commodity"}},"comment":{"type":"string"},"geoLocationConfidential":{"type":"boolean","description":"IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information."},"associatedStatements":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.AssociatedStatement"},"description":""},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":"A EUDR statement defines all the information that the Traces NT system requires to be submitted."}},"components/schemas/Integrations.Eudr.DDStatementCreate":{"id":"components/schemas/Integrations.Eudr.DDStatementCreate","kind":"json-schema","title":"Integrations.Eudr.DDStatementCreate","data":{"type":"object","properties":{"operatorType":{"$ref":"#/components/schemas/Integrations.Eudr.OperatorType"},"activityType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ActivityType"}],"description":"The activity type."},"countryOfActivity":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity."},"borderCrossCountry":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is required for IMPORT or EXPORT activities."},"comment":{"type":"string"},"geoLocationConfidential":{"type":"boolean","description":"IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information."},"associatedStatements":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.AssociatedStatement"},"description":""},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":"A EUDR statement defines all the information that the Traces NT system requires to be submitted."}},"components/schemas/Integrations.Eudr.DDStatementCreateOrUpdate":{"id":"components/schemas/Integrations.Eudr.DDStatementCreateOrUpdate","kind":"json-schema","title":"Integrations.Eudr.DDStatementCreateOrUpdate","data":{"type":"object","properties":{"operatorType":{"$ref":"#/components/schemas/Integrations.Eudr.OperatorType"},"activityType":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.ActivityType"}],"description":"The activity type."},"countryOfActivity":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is the country where the economic activity is taking place, typically (but not always) this is the operator's place of activity."},"borderCrossCountry":{"allOf":[{"$ref":"#/components/schemas/Shared.EuCountryCode"}],"description":"This is required for IMPORT or EXPORT activities."},"commodities":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.CommodityCreateOrUpdateItem"}},"comment":{"type":"string"},"geoLocationConfidential":{"type":"boolean","description":"IF this is set to true then downstream consumers of your DDS Reference will not have access to the Geo Location information."},"associatedStatements":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.AssociatedStatement"},"description":""},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":"A EUDR statement defines all the information that the Traces NT system requires to be submitted."}},"components/schemas/Integrations.Eudr.DDStatementPath":{"id":"components/schemas/Integrations.Eudr.DDStatementPath","kind":"json-schema","title":"Integrations.Eudr.DDStatementPath","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.DDSReferencePathRecordPath"}]}},"components/schemas/Integrations.Eudr.DirectRecords":{"id":"components/schemas/Integrations.Eudr.DirectRecords","kind":"json-schema","title":"Integrations.Eudr.DirectRecords","data":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"This is the source uris for the DDS Reference.","examples":[["/organisations{orgId}/deliveries/{deliveryId}","/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/items/{itemId}"]]}},"description":"Direct Records are those records that will be used to generate a DDS from. This can only be accessed for NEW DDS Reference types and if the DDS Statement has not been submitted."}},"components/schemas/Integrations.Eudr.FindDDSQuery":{"id":"components/schemas/Integrations.Eudr.FindDDSQuery","kind":"json-schema","title":"Integrations.Eudr.FindDDSQuery","data":{"type":"object","properties":{"referenceStatus":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.DDSStatus"}],"description":"List of Statuses that you want to include in the results. If ommitted it will return references with all states."}}}},"components/schemas/Integrations.Eudr.FindDDSReference":{"id":"components/schemas/Integrations.Eudr.FindDDSReference","kind":"json-schema","title":"Integrations.Eudr.FindDDSReference","data":{"type":"object","properties":{"recordUris":{"type":"array","items":{"type":"string"},"description":"The list of Record Uris to look for the DDS Reference for.","examples":[["/organisations/{orgId}/deliveries/{deliveryId}"]]}}}},"components/schemas/Integrations.Eudr.FindDDSReferencePath":{"id":"components/schemas/Integrations.Eudr.FindDDSReferencePath","kind":"json-schema","title":"Integrations.Eudr.FindDDSReferencePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Integrations.Eudr.Link":{"id":"components/schemas/Integrations.Eudr.Link","kind":"json-schema","title":"Integrations.Eudr.Link","data":{"type":"string","enum":["Direct","Associated"]}},"components/schemas/Integrations.Eudr.OperatorType":{"id":"components/schemas/Integrations.Eudr.OperatorType","kind":"json-schema","title":"Integrations.Eudr.OperatorType","data":{"type":"string","enum":["OPERATOR"]}},"components/schemas/Integrations.Eudr.OtherSourceResourceType":{"id":"components/schemas/Integrations.Eudr.OtherSourceResourceType","kind":"json-schema","title":"Integrations.Eudr.OtherSourceResourceType","data":{"type":"string","enum":["DELIVERY","ITEM","PURCHASE_ORDER"]}},"components/schemas/Integrations.Eudr.ProductQuantity":{"id":"components/schemas/Integrations.Eudr.ProductQuantity","kind":"json-schema","title":"Integrations.Eudr.ProductQuantity","data":{"type":"object","required":["uri","totalQuantity"],"properties":{"uri":{"type":"string","format":"uri","description":"This is the source product URI.","examples":["/organisations/{orgId}/products/{productId}"]},"totalQuantity":{"type":"number","format":"decimal","description":"This is the quantity to create the DDS for."},"supplementaryUnit":{"type":"string","description":"The supplementary unit for this product quantity."},"percentageEstimationOrDeviation":{"type":"number","format":"decimal","description":"The percentage estimation or deviation for this product quantity."}}}},"components/schemas/Integrations.Eudr.ProductSourceResourceType":{"id":"components/schemas/Integrations.Eudr.ProductSourceResourceType","kind":"json-schema","title":"Integrations.Eudr.ProductSourceResourceType","data":{"type":"string","enum":["PRODUCT"]}},"components/schemas/Integrations.Eudr.ProductionPlaceSource":{"id":"components/schemas/Integrations.Eudr.ProductionPlaceSource","kind":"json-schema","title":"Integrations.Eudr.ProductionPlaceSource","data":{"type":"string","enum":["SOURCE_RESOURCE_TYPE_SUPPLY_CHAIN","ORGANISATION_SUPPLY_CHAIN","STATIC_SUPPLY_CHAIN"]}},"components/schemas/Integrations.Eudr.RelationToRecordType":{"id":"components/schemas/Integrations.Eudr.RelationToRecordType","kind":"json-schema","title":"Integrations.Eudr.RelationToRecordType","data":{"type":"string","enum":["DIRECT","INDIRECT"]}},"components/schemas/Integrations.Eudr.ResolveDDSReferencePath":{"id":"components/schemas/Integrations.Eudr.ResolveDDSReferencePath","kind":"json-schema","title":"Integrations.Eudr.ResolveDDSReferencePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Integrations.Eudr.ResolveDDSRequest":{"id":"components/schemas/Integrations.Eudr.ResolveDDSRequest","kind":"json-schema","title":"Integrations.Eudr.ResolveDDSRequest","data":{"type":"object","properties":{"records":{"type":"array","items":{"type":"string"},"description":"The list of Record Uris to resolve DDS References for. This will look back through connected items (throw processes etc) to find any related DDS References.","examples":[["/organisations/{orgId}/deliveries/{deliveryId}"]]}}}},"components/schemas/Integrations.Eudr.ResolveDDSResult":{"id":"components/schemas/Integrations.Eudr.ResolveDDSResult","kind":"json-schema","title":"Integrations.Eudr.ResolveDDSResult","data":{"type":"object","required":["record"],"properties":{"record":{"type":"string","format":"uri","description":"This is the URI of the the record - i.e the Delivery, Purchase Order or Item","examples":["/organisations/{orgId}/items/{itemId}","/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/deliveries/{deliveryId}"]},"resolved":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.Resolved"},"description":"The records and the DDS References that were found."},"unresolved":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.UnResolved"},"description":"The records where resolution was not possible."}}}},"components/schemas/Integrations.Eudr.Resolved":{"id":"components/schemas/Integrations.Eudr.Resolved","kind":"json-schema","title":"Integrations.Eudr.Resolved","data":{"type":"object","required":["record"],"properties":{"record":{"type":"string","format":"uri","description":"This is the URI of the the record that the DDS was found attached to - i.e the Delivery, Purchase Order or Item","examples":["/organisations/{orgId}/items/{itemId}","/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/deliveries/{deliveryId}"]},"references":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ResolvedDDSReference"},"description":"The found Due Diligence Statement References."}}}},"components/schemas/Integrations.Eudr.ResolvedDDSReference":{"id":"components/schemas/Integrations.Eudr.ResolvedDDSReference","kind":"json-schema","title":"Integrations.Eudr.ResolvedDDSReference","data":{"type":"object","properties":{"internalReferenceNumber":{"type":"string","description":"An internal reference number provided by a user to help identify the DDS Reference."},"referenceNumber":{"type":"string","description":"The Reference Number as provided by TracesNT."},"verificationNumber":{"type":"string","description":"The Verification Number provided by Traces NT."}}}},"components/schemas/Integrations.Eudr.SourceResourceType":{"id":"components/schemas/Integrations.Eudr.SourceResourceType","kind":"json-schema","title":"Integrations.Eudr.SourceResourceType","data":{"type":"string","enum":["DELIVERY","ITEM","PRODUCT","PURCHASE_ORDER"]}},"components/schemas/Integrations.Eudr.Type":{"id":"components/schemas/Integrations.Eudr.Type","kind":"json-schema","title":"Integrations.Eudr.Type","data":{"type":"string","enum":["NEW","EXISTING"]}},"components/schemas/Integrations.Eudr.UnResolved":{"id":"components/schemas/Integrations.Eudr.UnResolved","kind":"json-schema","title":"Integrations.Eudr.UnResolved","data":{"type":"object","required":["record"],"properties":{"record":{"type":"string","format":"uri","description":"This is the URI of the the record that the DDS was found attached to - i.e the Delivery, Purchase Order or Item","examples":["/organisations/{orgId}/items/{itemId}","/organisations/{orgId}/purchase-orders/{purchaseOrderId}","/organisations/{orgId}/deliveries/{deliveryId}"]},"reason":{"allOf":[{"$ref":"#/components/schemas/Integrations.Eudr.UnresolvedReason"}],"description":"The reason why DDS Reference was not resolved for the given item."}}}},"components/schemas/Integrations.Eudr.UnresolvedReason":{"id":"components/schemas/Integrations.Eudr.UnresolvedReason","kind":"json-schema","title":"Integrations.Eudr.UnresolvedReason","data":{"type":"string","enum":["DDS_DOES_NOT_EXIST","SUBMITTED_OR_PENDING_DDS_EXISTS"]}},"components/schemas/OutboundSends.SendPath":{"id":"components/schemas/OutboundSends.SendPath","kind":"json-schema","title":"OutboundSends.SendPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/OutboundSends.SendRecord":{"id":"components/schemas/OutboundSends.SendRecord","kind":"json-schema","title":"OutboundSends.SendRecord","data":{"type":"object","properties":{"createdBy":{"type":"string","description":"User who created the record."},"createdTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & Time that the record was created."},"children":[]}]}]}]},"updatedBy":{"type":"string","description":"Last updated by user."},"updatedTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & Time that the record was last updated."},"children":[]}]}]}]},"id":{"type":"string","description":"System assigned or user defined id field."}},"allOf":[{"$ref":"#/components/schemas/OutboundSends.SendRecordRequest"}],"description":"Defines a share record."}},"components/schemas/OutboundSends.SendRecordPath":{"id":"components/schemas/OutboundSends.SendRecordPath","kind":"json-schema","title":"OutboundSends.SendRecordPath","data":{"type":"object","required":["outboundShareId"],"properties":{"outboundShareId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/OutboundSends.SendPath"}]}},"components/schemas/OutboundSends.SendRecordRequest":{"id":"components/schemas/OutboundSends.SendRecordRequest","kind":"json-schema","title":"OutboundSends.SendRecordRequest","data":{"type":"object","required":["receiverUri","rootRecordUri"],"properties":{"receiverUri":{"type":"string","format":"uri","description":"The URI for the connection that you want to share the record with.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"rootRecordUri":{"type":"string","format":"uri","description":"The URI for the main record to be shared with the counterparty.","examples":["/organisations/{orgId}/purchase-orders/{purchaseOrderId}"]},"recordUris":{"type":"array","items":{"type":"string"},"description":"The URI of other records to include in the send.","examples":[["/organisations/{orgId}/products/{productId}"]]}},"description":"Defines a new share."}},"components/schemas/Producer":{"id":"components/schemas/Producer","kind":"json-schema","title":"Producer","data":{"type":"object","required":["recordUri"],"properties":{"recordUri":{"type":"string"},"country":{"$ref":"#/components/schemas/Shared.CountryCode"},"name":{"type":"string"},"productionPlaces":{"type":"array","items":{"$ref":"#/components/schemas/ProductionPlace"}}}}},"components/schemas/ProductionPlace":{"id":"components/schemas/ProductionPlace","kind":"json-schema","title":"ProductionPlace","data":{"type":"object","required":["locationUri"],"properties":{"locationUri":{"type":"string"},"name":{"type":"string"},"geoData":{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection"},"areaInHa":{"type":"number","format":"decimal"}}}},"components/schemas/Reports.PointOfOrigin.ReportSourceResourceType":{"id":"components/schemas/Reports.PointOfOrigin.ReportSourceResourceType","kind":"json-schema","title":"Reports.PointOfOrigin.ReportSourceResourceType","data":{"type":"string","enum":["DELIVERY","ITEM","PURCHASE_ORDER","PRODUCT"]}},"components/schemas/Shared.CountryCode":{"id":"components/schemas/Shared.CountryCode","kind":"json-schema","title":"Shared.CountryCode","data":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}},"components/schemas/Shared.EuCountryCode":{"id":"components/schemas/Shared.EuCountryCode","kind":"json-schema","title":"Shared.EuCountryCode","data":{"type":"string","enum":["AT","BE","BG","HR","CY","CZ","DK","EE","FI","FR","DE","GR","HU","IE","IT","LV","LT","LU","MT","NL","PL","PT","RO","SK","SI","ES","SE","XI"]}},"components/schemas/SpeciesInfo":{"id":"components/schemas/SpeciesInfo","kind":"json-schema","title":"SpeciesInfo","data":{"type":"object","required":["materialUri"],"properties":{"materialUri":{"type":"string"},"commonName":{"type":"string"},"scientificName":{"type":"string"}}}},"components/schemas/Static.AdditionalUnit":{"id":"components/schemas/Static.AdditionalUnit","kind":"json-schema","title":"Static.AdditionalUnit","data":{"type":"object","required":["baseUnit","conversionFactor"],"properties":{"baseUnit":{"type":"string","format":"uri","description":"The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.","examples":["/common/base-units/{unitId}","/common/base-units/{unitId}"]},"conversionFactor":{"type":"number","format":"decimal","description":"The conversion factor from product base unit to conversion base unit."}}}},"components/schemas/Static.ConnectStatus":{"id":"components/schemas/Static.ConnectStatus","kind":"json-schema","title":"Static.ConnectStatus","data":{"type":"string","enum":["CONNECTED","DISCONNECTED","ABANDONED"]}},"components/schemas/Static.Connection":{"id":"components/schemas/Static.Connection","kind":"json-schema","title":"Static.Connection","data":{"type":"object","required":["name","address","connectStatus"],"properties":{"name":{"type":"string","description":"The name of the connected organisation."},"publicUri":{"type":"string","description":"This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up."},"parentUri":{"type":"string","description":"If this connection is actually part of your group of companies then this should point to your organisation URI."},"website":{"type":"string","description":"The corporate website for this organisation."},"email":{"type":"string","description":"Contact email address for the organisation."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"The address of the corporate headquarters."},"connectStatus":{"allOf":[{"$ref":"#/components/schemas/Static.ConnectStatus"}],"description":"This is the status of connection to the organisation. In order to send records to or receive record from an organisation the two organisations must be connected."},"connectStatusUpdatedTime":{"type":"string","format":"date-time","description":"The time and date when the connection status was updated."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"A connection represents an organisation that has a relationship with the current organisation. This might be a supplier, customer or other partner. It represents a legal entity."}},"components/schemas/Static.ConnectionCreate":{"id":"components/schemas/Static.ConnectionCreate","kind":"json-schema","title":"Static.ConnectionCreate","data":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","description":"The name of the connected organisation."},"publicUri":{"type":"string","description":"This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up."},"parentUri":{"type":"string","description":"If this connection is actually part of your group of companies then this should point to your organisation URI."},"website":{"type":"string","description":"The corporate website for this organisation."},"email":{"type":"string","description":"Contact email address for the organisation."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"The address of the corporate headquarters."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"A connection represents an organisation that has a relationship with the current organisation. This might be a supplier, customer or other partner. It represents a legal entity."}},"components/schemas/Static.ConnectionCreateOrUpdate":{"id":"components/schemas/Static.ConnectionCreateOrUpdate","kind":"json-schema","title":"Static.ConnectionCreateOrUpdate","data":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","description":"The name of the connected organisation."},"publicUri":{"type":"string","description":"This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up."},"parentUri":{"type":"string","description":"If this connection is actually part of your group of companies then this should point to your organisation URI."},"website":{"type":"string","description":"The corporate website for this organisation."},"email":{"type":"string","description":"Contact email address for the organisation."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"The address of the corporate headquarters."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"A connection represents an organisation that has a relationship with the current organisation. This might be a supplier, customer or other partner. It represents a legal entity."}},"components/schemas/Static.ConnectionPath":{"id":"components/schemas/Static.ConnectionPath","kind":"json-schema","title":"Static.ConnectionPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Static.ConnectionPathRecord":{"id":"components/schemas/Static.ConnectionPathRecord","kind":"json-schema","title":"Static.ConnectionPathRecord","data":{"type":"object","required":["connectionId"],"properties":{"connectionId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.ConnectionPath"}]}},"components/schemas/Static.Conversion":{"id":"components/schemas/Static.Conversion","kind":"json-schema","title":"Static.Conversion","data":{"type":"object","required":["baseUnitUri","conversionFactor"],"properties":{"baseUnitUri":{"type":"string","format":"uri","description":"The URI to the base unit of measurement to convert the base qty to. So if the product is specified in units and the conversion specifies kg then this conversion will provide the per unit mass.","examples":["/common/base-units/{unitId}"]},"conversionFactor":{"type":"number","format":"decimal","description":"The conversion factor from product base unit to conversion base unit."}}}},"components/schemas/Static.Location":{"id":"components/schemas/Static.Location","kind":"json-schema","title":"Static.Location","data":{"type":"object","required":["name","types","address"],"properties":{"name":{"type":"string","description":"The name of the location/site."},"types":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the type(s) of the location/site.","examples":[["/organisations/{orgId}/location-types/{locationTypeId}"]]},"address":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.Geo.Address"}],"description":"The location/site address."},"geoLocation":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection"}],"description":"The GeoJSON geolocation for this location."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or sites) are an essential part of the Interu traceability method. They represent physical locations and areas involved in the physical flow of goods. For instance, a manufacturing Organisation may have multiple Locations, each one the factory address where processing happens."},"children":[]}]}]}]}]}},"components/schemas/Static.LocationCreate":{"id":"components/schemas/Static.LocationCreate","kind":"json-schema","title":"Static.LocationCreate","data":{"type":"object","required":["name","types","address"],"properties":{"name":{"type":"string","description":"The name of the location/site."},"types":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the type(s) of the location/site.","examples":[["/organisations/{orgId}/location-types/{locationTypeId}"]]},"address":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.Geo.Address"}],"description":"The location/site address."},"geoLocation":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection"}],"description":"The GeoJSON geolocation for this location."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or sites) are an essential part of the Interu traceability method. They represent physical locations and areas involved in the physical flow of goods. For instance, a manufacturing Organisation may have multiple Locations, each one the factory address where processing happens."},"children":[]}]}]}]}]}},"components/schemas/Static.LocationCreateOrUpdate":{"id":"components/schemas/Static.LocationCreateOrUpdate","kind":"json-schema","title":"Static.LocationCreateOrUpdate","data":{"type":"object","required":["name","types","address"],"properties":{"name":{"type":"string","description":"The name of the location/site."},"types":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the type(s) of the location/site.","examples":[["/organisations/{orgId}/location-types/{locationTypeId}"]]},"address":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.Geo.Address"}],"description":"The location/site address."},"geoLocation":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection"}],"description":"The GeoJSON geolocation for this location."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or sites) are an essential part of the Interu traceability method. They represent physical locations and areas involved in the physical flow of goods. For instance, a manufacturing Organisation may have multiple Locations, each one the factory address where processing happens."},"children":[]}]}]}]}]}},"components/schemas/Static.LocationLink":{"id":"components/schemas/Static.LocationLink","kind":"json-schema","title":"Static.LocationLink","data":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"uri","description":"The URI of the source location. This is the upstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the target location. This is the downstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":"Locations can be linked to represent the flow of goods in the supply chain."}},"components/schemas/Static.LocationLinkCreate":{"id":"components/schemas/Static.LocationLinkCreate","kind":"json-schema","title":"Static.LocationLinkCreate","data":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"uri","description":"The URI of the source location. This is the upstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the target location. This is the downstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":"Locations can be linked to represent the flow of goods in the supply chain."}},"components/schemas/Static.LocationLinkCreateOrUpdate":{"id":"components/schemas/Static.LocationLinkCreateOrUpdate","kind":"json-schema","title":"Static.LocationLinkCreateOrUpdate","data":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","format":"uri","description":"The URI of the source location. This is the upstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the target location. This is the downstream location in the supply chain.","examples":["/organisations/{orgId}/locations/{locationId}"]}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":"Locations can be linked to represent the flow of goods in the supply chain."}},"components/schemas/Static.LocationLinkPath":{"id":"components/schemas/Static.LocationLinkPath","kind":"json-schema","title":"Static.LocationLinkPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Static.LocationLinkPathRecord":{"id":"components/schemas/Static.LocationLinkPathRecord","kind":"json-schema","title":"Static.LocationLinkPathRecord","data":{"type":"object","required":["linkId"],"properties":{"linkId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.LocationLinkPath"}]}},"components/schemas/Static.LocationPath":{"id":"components/schemas/Static.LocationPath","kind":"json-schema","title":"Static.LocationPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Static.LocationPathRecord":{"id":"components/schemas/Static.LocationPathRecord","kind":"json-schema","title":"Static.LocationPathRecord","data":{"type":"object","required":["locationId"],"properties":{"locationId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.LocationPath"}]}},"components/schemas/Static.Material":{"id":"components/schemas/Static.Material","kind":"json-schema","title":"Static.Material","data":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","description":"The name of the material."},"scientificName":{"type":"string","description":"This is the Scientific Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"commonName":{"type":"string","description":"This is a Common Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"category":{"type":"string","description":"The category for the material."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"The definition of a material."}},"components/schemas/Static.MaterialCreate":{"id":"components/schemas/Static.MaterialCreate","kind":"json-schema","title":"Static.MaterialCreate","data":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","description":"The name of the material."},"scientificName":{"type":"string","description":"This is the Scientific Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"commonName":{"type":"string","description":"This is a Common Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"category":{"type":"string","description":"The category for the material."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"The definition of a material."}},"components/schemas/Static.MaterialCreateOrUpdate":{"id":"components/schemas/Static.MaterialCreateOrUpdate","kind":"json-schema","title":"Static.MaterialCreateOrUpdate","data":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","description":"The name of the material."},"scientificName":{"type":"string","description":"This is the Scientific Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"commonName":{"type":"string","description":"This is a Common Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"category":{"type":"string","description":"The category for the material."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"The definition of a material."}},"components/schemas/Static.MaterialPath":{"id":"components/schemas/Static.MaterialPath","kind":"json-schema","title":"Static.MaterialPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Static.MaterialPathRecord":{"id":"components/schemas/Static.MaterialPathRecord","kind":"json-schema","title":"Static.MaterialPathRecord","data":{"type":"object","required":["materialId"],"properties":{"materialId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.MaterialPath"}]}},"components/schemas/Static.Product":{"id":"components/schemas/Static.Product","kind":"json-schema","title":"Static.Product","data":{"type":"object","required":["name","allowedMaterials","baseUnit","additionalUnits"],"properties":{"name":{"type":"string","description":"The name for the product."},"hsCode":{"type":"string","description":"This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system."},"description":{"type":"string","description":"This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system."},"allowedMaterials":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the material(s) that are allowed to be used for this product.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"baseUnit":{"type":"string","format":"uri","description":"The URI to the base unit of measurement that this product is specified in.","examples":["/common/base-units/{unitId}"]},"defaultUnit":{"type":"string","format":"uri","description":"The URI to the unit of measurement that you wish to use as the default unit of measurement.","examples":["/common/base-units/{unitId}"]},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg"},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"This is a definition of a product. Typically this represents an SKU."}},"components/schemas/Static.ProductCreate":{"id":"components/schemas/Static.ProductCreate","kind":"json-schema","title":"Static.ProductCreate","data":{"type":"object","required":["name","allowedMaterials","baseUnit","additionalUnits"],"properties":{"name":{"type":"string","description":"The name for the product."},"hsCode":{"type":"string","description":"This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system."},"description":{"type":"string","description":"This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system."},"allowedMaterials":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the material(s) that are allowed to be used for this product.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"baseUnit":{"type":"string","format":"uri","description":"The URI to the base unit of measurement that this product is specified in.","examples":["/common/base-units/{unitId}"]},"defaultUnit":{"type":"string","format":"uri","description":"The URI to the unit of measurement that you wish to use as the default unit of measurement.","examples":["/common/base-units/{unitId}"]},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg"}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"This is a definition of a product. Typically this represents an SKU."}},"components/schemas/Static.ProductCreateOrUpdate":{"id":"components/schemas/Static.ProductCreateOrUpdate","kind":"json-schema","title":"Static.ProductCreateOrUpdate","data":{"type":"object","required":["name","allowedMaterials","baseUnit","additionalUnits"],"properties":{"name":{"type":"string","description":"The name for the product."},"hsCode":{"type":"string","description":"This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system."},"description":{"type":"string","description":"This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system."},"allowedMaterials":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the material(s) that are allowed to be used for this product.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"baseUnit":{"type":"string","format":"uri","description":"The URI to the base unit of measurement that this product is specified in.","examples":["/common/base-units/{unitId}"]},"defaultUnit":{"type":"string","format":"uri","description":"The URI to the unit of measurement that you wish to use as the default unit of measurement.","examples":["/common/base-units/{unitId}"]},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg"}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"This is a definition of a product. Typically this represents an SKU."}},"components/schemas/Static.ProductPath":{"id":"components/schemas/Static.ProductPath","kind":"json-schema","title":"Static.ProductPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Static.ProductPathRecord":{"id":"components/schemas/Static.ProductPathRecord","kind":"json-schema","title":"Static.ProductPathRecord","data":{"type":"object","required":["productId"],"properties":{"productId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.ProductPath"}]}},"components/schemas/Static.QueryLinkDirection":{"id":"components/schemas/Static.QueryLinkDirection","kind":"json-schema","title":"Static.QueryLinkDirection","data":{"type":"string","enum":["FROM","TO","BOTH"]}},"components/schemas/Static.UpdateConnection":{"id":"components/schemas/Static.UpdateConnection","kind":"json-schema","title":"Static.UpdateConnection","data":{"type":"object","required":["name","address"],"properties":{"name":{"type":"string","description":"The name of the connected organisation."},"publicUri":{"type":"string","description":"This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up."},"parentUri":{"type":"string","description":"If this connection is actually part of your group of companies then this should point to your organisation URI."},"website":{"type":"string","description":"The corporate website for this organisation."},"email":{"type":"string","description":"Contact email address for the organisation."},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"The address of the corporate headquarters."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.UpdateConnectionUpdate":{"id":"components/schemas/Static.UpdateConnectionUpdate","kind":"json-schema","title":"Static.UpdateConnectionUpdate","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the connected organisation."},"publicUri":{"type":"string","description":"This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up."},"parentUri":{"type":"string","description":"If this connection is actually part of your group of companies then this should point to your organisation URI."},"website":{"type":"string","description":"The corporate website for this organisation."},"email":{"type":"string","description":"Contact email address for the organisation."},"address":{"allOf":[{"$ref":"#/components/schemas/AddressUpdate"}],"description":"The address of the corporate headquarters."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.UpdateLocation":{"id":"components/schemas/Static.UpdateLocation","kind":"json-schema","title":"Static.UpdateLocation","data":{"type":"object","required":["name","types","address"],"properties":{"name":{"type":"string","description":"The name of the location/site."},"types":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the type(s) of the location/site.","examples":[["/organisations/{orgId}/location-types/{locationTypeId}"],["/organisations/{orgId}/location-types/{locationTypeId}"]]},"address":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.Geo.Address"}],"description":"The location/site address."},"geoLocation":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeatureCollection"}],"description":"The GeoJSON geolocation for this location."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.UpdateMaterial":{"id":"components/schemas/Static.UpdateMaterial","kind":"json-schema","title":"Static.UpdateMaterial","data":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","description":"The name of the material."},"scientificName":{"type":"string","description":"This is the Scientific Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"commonName":{"type":"string","description":"This is a Common Name for this material. It is an optional field but is required for sbmission to the Traces NT system."},"category":{"type":"string","description":"The category for the material."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.UpdateProduct":{"id":"components/schemas/Static.UpdateProduct","kind":"json-schema","title":"Static.UpdateProduct","data":{"type":"object","required":["name","allowedMaterials","baseUnit","additionalUnits"],"properties":{"name":{"type":"string","description":"The name for the product."},"hsCode":{"type":"string","description":"This is the HS (Harmonised Standard) code for the product. This is optional unless this product will be part of submission to the Traces NT system."},"description":{"type":"string","description":"This is a simple description for the product. This is optional unless this product will be part of submission to the Traces NT system."},"allowedMaterials":{"type":"array","items":{"type":"string"},"description":"The URI(s) of the material(s) that are allowed to be used for this product.","examples":[["/organisations/{orgId}/materials/{materialId}"],["/organisations/{orgId}/materials/{materialId}"]]},"baseUnit":{"type":"string","format":"uri","description":"The URI to the base unit of measurement that this product is specified in.","examples":["/common/base-units/{unitId}","/common/base-units/{unitId}"]},"defaultUnit":{"type":"string","format":"uri","description":"The URI to the unit of measurement that you wish to use as the default unit of measurement.","examples":["/common/base-units/{unitId}","/common/base-units/{unitId}"]},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional units that specify the factor for converting from the base unit to other base units: e.g. unit to kg"},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.UpdateVariant":{"id":"components/schemas/Static.UpdateVariant","kind":"json-schema","title":"Static.UpdateVariant","data":{"type":"object","required":["description","additionalUnits"],"properties":{"description":{"type":"string","description":"The identity for of the variant. This needs to be unique in the context of the product."},"sku":{"type":"string","description":"If you want to store the SKU number separately from the description this field is available."},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Static.Variant":{"id":"components/schemas/Static.Variant","kind":"json-schema","title":"Static.Variant","data":{"type":"object","required":["description","additionalUnits"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"description":{"type":"string","description":"The identity for of the variant. This needs to be unique in the context of the product."},"sku":{"type":"string","description":"If you want to store the SKU number separately from the description this field is available."},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.Base"}]}},"components/schemas/Static.VariantCreate":{"id":"components/schemas/Static.VariantCreate","kind":"json-schema","title":"Static.VariantCreate","data":{"type":"object","required":["description","additionalUnits"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"description":{"type":"string","description":"The identity for of the variant. This needs to be unique in the context of the product."},"sku":{"type":"string","description":"If you want to store the SKU number separately from the description this field is available."},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreate"}]}},"components/schemas/Static.VariantCreateOrUpdate":{"id":"components/schemas/Static.VariantCreateOrUpdate","kind":"json-schema","title":"Static.VariantCreateOrUpdate","data":{"type":"object","required":["description","additionalUnits"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"description":{"type":"string","description":"The identity for of the variant. This needs to be unique in the context of the product."},"sku":{"type":"string","description":"If you want to store the SKU number separately from the description this field is available."},"additionalUnits":{"type":"array","items":{"$ref":"#/components/schemas/Static.AdditionalUnit"},"description":"A list of additional Units that specify the factor for converting from the base unit to other base units: e.g. unit to kg specific to this variant."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseCreateOrUpdate"}]}},"components/schemas/Static.VariantRecordPath":{"id":"components/schemas/Static.VariantRecordPath","kind":"json-schema","title":"Static.VariantRecordPath","data":{"type":"object","required":["variantId"],"properties":{"variantId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Static.ProductPathRecord"}]}},"components/schemas/Transactional.AdditionalQuantity":{"id":"components/schemas/Transactional.AdditionalQuantity","kind":"json-schema","title":"Transactional.AdditionalQuantity","data":{"type":"object","required":["baseUnit","conversionQuantity","overrideQuantity"],"properties":{"baseUnit":{"type":"string","description":"The additional quantity base unit of measurement."},"conversionQuantity":{"type":"number","format":"decimal","description":"The additional quantity calculated if the product has a conversion to that base unit."},"overrideQuantity":{"type":"number","format":"decimal","description":"An override quantity provided irrespective of whether or not there is a conversion on the product."}}}},"components/schemas/Transactional.Delivery":{"id":"components/schemas/Transactional.Delivery","kind":"json-schema","title":"Transactional.Delivery","data":{"type":"object","required":["deliveryId","from","to","status"],"properties":{"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The current status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been delivered."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.DeliveryItem"},"description":"List of items included in the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of agent organisation URIs that are associated with the delivery."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"Associated Purchase Orders"},"supplyChainUri":{"type":"string","format":"uri","description":"The URI of the supply chain associated with this delivery."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"Represents a delivery/shipment within a supply chain. This may be inbound or outbound for an organisation."}},"components/schemas/Transactional.DeliveryCreate":{"id":"components/schemas/Transactional.DeliveryCreate","kind":"json-schema","title":"Transactional.DeliveryCreate","data":{"type":"object","required":["deliveryId","from","to","status"],"properties":{"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The current status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been delivered."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.DeliveryItem"},"description":"List of items included in the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of agent organisation URIs that are associated with the delivery."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"Associated Purchase Orders"},"supplyChainUri":{"type":"string","format":"uri","description":"The URI of the supply chain associated with this delivery."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"Represents a delivery/shipment within a supply chain. This may be inbound or outbound for an organisation."}},"components/schemas/Transactional.DeliveryCreateOrUpdate":{"id":"components/schemas/Transactional.DeliveryCreateOrUpdate","kind":"json-schema","title":"Transactional.DeliveryCreateOrUpdate","data":{"type":"object","required":["deliveryId","from","to","status"],"properties":{"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The current status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been delivered."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.DeliveryItem"},"description":"List of items included in the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of agent organisation URIs that are associated with the delivery."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"Associated Purchase Orders"},"supplyChainUri":{"type":"string","format":"uri","description":"The URI of the supply chain associated with this delivery."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"Represents a delivery/shipment within a supply chain. This may be inbound or outbound for an organisation."}},"components/schemas/Transactional.DeliveryItem":{"id":"components/schemas/Transactional.DeliveryItem","kind":"json-schema","title":"Transactional.DeliveryItem","data":{"type":"object","required":["item","quantity"],"properties":{"item":{"type":"string","format":"uri","description":"The URI of the item included in the delivery.","examples":["/organisations/{orgId}/items/{itemId}","/organisations/{orgId}/items/{itemId}"]},"quantity":{"type":"number","format":"decimal","description":"The quantity of the item included in the delivery."}},"description":"Represents an item that is part of the delivery."}},"components/schemas/Transactional.DeliveryPath":{"id":"components/schemas/Transactional.DeliveryPath","kind":"json-schema","title":"Transactional.DeliveryPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Transactional.DeliveryPathRecord":{"id":"components/schemas/Transactional.DeliveryPathRecord","kind":"json-schema","title":"Transactional.DeliveryPathRecord","data":{"type":"object","required":["deliveryId"],"properties":{"deliveryId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryPath"}]}},"components/schemas/Transactional.DeliveryStatus":{"id":"components/schemas/Transactional.DeliveryStatus","kind":"json-schema","title":"Transactional.DeliveryStatus","data":{"type":"string","enum":["DELIVERED","PENDING","IN_PROGRESS"]}},"components/schemas/Transactional.Item":{"id":"components/schemas/Transactional.Item","kind":"json-schema","title":"Transactional.Item","data":{"type":"object","required":["itemId","product","createdAtLocation","currentLocation","created","initialQuantity","additionalInitialQuantities"],"properties":{"itemId":{"type":"string","description":"User defined id for the item."},"product":{"type":"string","format":"uri","description":"URI for the product that the item is.","examples":["/organisations/{orgId}/products/{productId}"]},"createdAtLocation":{"type":"string","format":"uri","description":"URI for the location where the product was created.","examples":["/organisations/{orgId}/locations/{locationId}"]},"materials":{"type":"array","items":{"type":"string"},"description":"List of material URIs that are used within the item.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"currentLocation":{"type":"string","format":"uri","description":"URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).","examples":["/organisations/{orgId}/locations/{locationId}"]},"created":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The Date or Date Range that the item was created on."},"initialQuantity":{"type":"number","format":"decimal","description":"This quantity contained within this item at the point when it was created."},"additionalInitialQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."},"remainingQuantity":{"type":"number","format":"decimal","description":"If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process."},"productVariant":{"type":"string","format":"uri","description":"The uri of the product variant if applicable to this item.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"batchNumbers":{"type":"array","items":{"type":"string"},"description":"If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers."},"recordState":{"allOf":[{"$ref":"#/components/schemas/Common.Enums.RecordState"}],"description":"State of the record."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"Represents an item within the supply chain. Items can be found in deliveries or processes, they represent goods as they flow through the supply chain."}},"components/schemas/Transactional.ItemCreate":{"id":"components/schemas/Transactional.ItemCreate","kind":"json-schema","title":"Transactional.ItemCreate","data":{"type":"object","required":["itemId","product","createdAtLocation","currentLocation","created","initialQuantity","additionalInitialQuantities"],"properties":{"itemId":{"type":"string","description":"User defined id for the item."},"product":{"type":"string","format":"uri","description":"URI for the product that the item is.","examples":["/organisations/{orgId}/products/{productId}"]},"createdAtLocation":{"type":"string","format":"uri","description":"URI for the location where the product was created.","examples":["/organisations/{orgId}/locations/{locationId}"]},"materials":{"type":"array","items":{"type":"string"},"description":"List of material URIs that are used within the item.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"currentLocation":{"type":"string","format":"uri","description":"URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).","examples":["/organisations/{orgId}/locations/{locationId}"]},"created":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The Date or Date Range that the item was created on."},"initialQuantity":{"type":"number","format":"decimal","description":"This quantity contained within this item at the point when it was created."},"additionalInitialQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."},"remainingQuantity":{"type":"number","format":"decimal","description":"If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process."},"productVariant":{"type":"string","format":"uri","description":"The uri of the product variant if applicable to this item.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"batchNumbers":{"type":"array","items":{"type":"string"},"description":"If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"Represents an item within the supply chain. Items can be found in deliveries or processes, they represent goods as they flow through the supply chain."}},"components/schemas/Transactional.ItemCreateOrUpdate":{"id":"components/schemas/Transactional.ItemCreateOrUpdate","kind":"json-schema","title":"Transactional.ItemCreateOrUpdate","data":{"type":"object","required":["itemId","product","createdAtLocation","currentLocation","created","initialQuantity","additionalInitialQuantities"],"properties":{"itemId":{"type":"string","description":"User defined id for the item."},"product":{"type":"string","format":"uri","description":"URI for the product that the item is.","examples":["/organisations/{orgId}/products/{productId}"]},"createdAtLocation":{"type":"string","format":"uri","description":"URI for the location where the product was created.","examples":["/organisations/{orgId}/locations/{locationId}"]},"materials":{"type":"array","items":{"type":"string"},"description":"List of material URIs that are used within the item.","examples":[["/organisations/{orgId}/materials/{materialId}"]]},"currentLocation":{"type":"string","format":"uri","description":"URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).","examples":["/organisations/{orgId}/locations/{locationId}"]},"created":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The Date or Date Range that the item was created on."},"initialQuantity":{"type":"number","format":"decimal","description":"This quantity contained within this item at the point when it was created."},"additionalInitialQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."},"remainingQuantity":{"type":"number","format":"decimal","description":"If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process."},"productVariant":{"type":"string","format":"uri","description":"The uri of the product variant if applicable to this item.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"batchNumbers":{"type":"array","items":{"type":"string"},"description":"If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"Represents an item within the supply chain. Items can be found in deliveries or processes, they represent goods as they flow through the supply chain."}},"components/schemas/Transactional.ItemPath":{"id":"components/schemas/Transactional.ItemPath","kind":"json-schema","title":"Transactional.ItemPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Transactional.ItemPathRecord":{"id":"components/schemas/Transactional.ItemPathRecord","kind":"json-schema","title":"Transactional.ItemPathRecord","data":{"type":"object","required":["itemId"],"properties":{"itemId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Transactional.ItemPath"}]}},"components/schemas/Transactional.Process":{"id":"components/schemas/Transactional.Process","kind":"json-schema","title":"Transactional.Process","data":{"type":"object","required":["processId","type","location","state","firstInputDate","lastOutputDate"],"properties":{"processId":{"type":"string","description":"The process id."},"type":{"type":"string","format":"uri","description":"The URI of the type of process.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]},"location":{"type":"string","format":"uri","description":"The URI of the location that this process was carried out at.","examples":["/organisations/{orgId}/locations/{locationId}"]},"state":{"allOf":[{"$ref":"#/components/schemas/Transactional.ProcessState"}],"description":"Contains the process state. It governs what you can or cannot do with the process."},"firstInputDate":{"type":"string","format":"date-time","description":"The first date for input."},"lastOutputDate":{"type":"string","format":"date-time","description":"The last date for output."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"A process represents an activity that occurs within an organisation. This may be a conversion from one or more Item types into other Item types or a processes such as bundling."}},"components/schemas/Transactional.ProcessCreate":{"id":"components/schemas/Transactional.ProcessCreate","kind":"json-schema","title":"Transactional.ProcessCreate","data":{"type":"object","required":["processId","type","location","state","firstInputDate","lastOutputDate"],"properties":{"processId":{"type":"string","description":"The process id."},"type":{"type":"string","format":"uri","description":"The URI of the type of process.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]},"location":{"type":"string","format":"uri","description":"The URI of the location that this process was carried out at.","examples":["/organisations/{orgId}/locations/{locationId}"]},"state":{"allOf":[{"$ref":"#/components/schemas/Transactional.ProcessState"}],"description":"Contains the process state. It governs what you can or cannot do with the process."},"firstInputDate":{"type":"string","format":"date-time","description":"The first date for input."},"lastOutputDate":{"type":"string","format":"date-time","description":"The last date for output."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"A process represents an activity that occurs within an organisation. This may be a conversion from one or more Item types into other Item types or a processes such as bundling."}},"components/schemas/Transactional.ProcessCreateOrUpdate":{"id":"components/schemas/Transactional.ProcessCreateOrUpdate","kind":"json-schema","title":"Transactional.ProcessCreateOrUpdate","data":{"type":"object","required":["processId","type","location","state","firstInputDate","lastOutputDate"],"properties":{"processId":{"type":"string","description":"The process id."},"type":{"type":"string","format":"uri","description":"The URI of the type of process.","examples":["/organisations/{orgId}/process-types/{processTypeId}"]},"location":{"type":"string","format":"uri","description":"The URI of the location that this process was carried out at.","examples":["/organisations/{orgId}/locations/{locationId}"]},"state":{"allOf":[{"$ref":"#/components/schemas/Transactional.ProcessState"}],"description":"Contains the process state. It governs what you can or cannot do with the process."},"firstInputDate":{"type":"string","format":"date-time","description":"The first date for input."},"lastOutputDate":{"type":"string","format":"date-time","description":"The last date for output."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"A process represents an activity that occurs within an organisation. This may be a conversion from one or more Item types into other Item types or a processes such as bundling."}},"components/schemas/Transactional.ProcessInput":{"id":"components/schemas/Transactional.ProcessInput","kind":"json-schema","title":"Transactional.ProcessInput","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were added."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessInputItem"},"description":"The process input items URIs"},"note":{"type":"string","description":"A note to attach to the particular input."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":"Captures a set of items that were input to a Process and the quantity that was used."}},"components/schemas/Transactional.ProcessInputCreate":{"id":"components/schemas/Transactional.ProcessInputCreate","kind":"json-schema","title":"Transactional.ProcessInputCreate","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were added."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessInputItem"},"description":"The process input items URIs"},"note":{"type":"string","description":"A note to attach to the particular input."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":"Captures a set of items that were input to a Process and the quantity that was used."}},"components/schemas/Transactional.ProcessInputCreateOrUpdate":{"id":"components/schemas/Transactional.ProcessInputCreateOrUpdate","kind":"json-schema","title":"Transactional.ProcessInputCreateOrUpdate","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were added."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessInputItem"},"description":"The process input items URIs"},"note":{"type":"string","description":"A note to attach to the particular input."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":"Captures a set of items that were input to a Process and the quantity that was used."}},"components/schemas/Transactional.ProcessInputItem":{"id":"components/schemas/Transactional.ProcessInputItem","kind":"json-schema","title":"Transactional.ProcessInputItem","data":{"type":"object","required":["item","selectedQuantity"],"properties":{"item":{"type":"string","format":"uri","description":"The URI of the item that was put into the process.","examples":["/organisations/{orgId}/items/{itemId}"]},"selectedQuantity":{"type":"number","format":"decimal","description":"The quantity of the item that was processed."}},"description":"The item that was input to a process."}},"components/schemas/Transactional.ProcessOutput":{"id":"components/schemas/Transactional.ProcessOutput","kind":"json-schema","title":"Transactional.ProcessOutput","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were output."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessOutputItem"},"description":"The process output items"},"note":{"type":"string","description":"A note to attach to the particular output."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutId"}],"description":"Captures a set of items that were output from a Process."}},"components/schemas/Transactional.ProcessOutputCreate":{"id":"components/schemas/Transactional.ProcessOutputCreate","kind":"json-schema","title":"Transactional.ProcessOutputCreate","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were output."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessOutputItem"},"description":"The process output items"},"note":{"type":"string","description":"A note to attach to the particular output."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreate"}],"description":"Captures a set of items that were output from a Process."}},"components/schemas/Transactional.ProcessOutputCreateOrUpdate":{"id":"components/schemas/Transactional.ProcessOutputCreateOrUpdate","kind":"json-schema","title":"Transactional.ProcessOutputCreateOrUpdate","data":{"type":"object","required":["date","items","note"],"properties":{"date":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The date or date range that the items were output."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessOutputItem"},"description":"The process output items"},"note":{"type":"string","description":"A note to attach to the particular output."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithoutIdCreateOrUpdate"}],"description":"Captures a set of items that were output from a Process."}},"components/schemas/Transactional.ProcessOutputItem":{"id":"components/schemas/Transactional.ProcessOutputItem","kind":"json-schema","title":"Transactional.ProcessOutputItem","data":{"type":"object","required":["item"],"properties":{"item":{"type":"string","format":"uri","description":"The URI of the item that was output from the process.","examples":["/organisations/{orgId}/items/{itemId}"]}},"description":"The item that was output from a process."}},"components/schemas/Transactional.ProcessPath":{"id":"components/schemas/Transactional.ProcessPath","kind":"json-schema","title":"Transactional.ProcessPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Transactional.ProcessPathRecord":{"id":"components/schemas/Transactional.ProcessPathRecord","kind":"json-schema","title":"Transactional.ProcessPathRecord","data":{"type":"object","required":["processId"],"properties":{"processId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Transactional.ProcessPath"}]}},"components/schemas/Transactional.ProcessState":{"id":"components/schemas/Transactional.ProcessState","kind":"json-schema","title":"Transactional.ProcessState","data":{"type":"string","enum":["INPUT_OUTPUT","OUTPUT_ONLY","CLOSED"]}},"components/schemas/Transactional.PurchaseOrder":{"id":"components/schemas/Transactional.PurchaseOrder","kind":"json-schema","title":"Transactional.PurchaseOrder","data":{"type":"object","required":["number","status","lineItems"],"properties":{"number":{"type":"string","description":"The purchase order number."},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The current status of the purchase order."},"orderDate":{"type":"string","format":"date-time","description":"The date and time of the purchase order."},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date and time the delivery is expected to arrive."},"supplier":{"type":"string","format":"uri","description":"The URI of the supplier.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"buyer":{"type":"string","format":"uri","description":"The URI of the buyer.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"deliverToLocation":{"type":"string","format":"uri","description":"The URI of the deliver to location.","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderItem"},"description":"List of items included in the purchase order."},"note":{"type":"string","description":"A note to pass any information."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithId"}],"description":"Represents a purchase order."}},"components/schemas/Transactional.PurchaseOrderCreate":{"id":"components/schemas/Transactional.PurchaseOrderCreate","kind":"json-schema","title":"Transactional.PurchaseOrderCreate","data":{"type":"object","required":["number","status","lineItems"],"properties":{"number":{"type":"string","description":"The purchase order number."},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The current status of the purchase order."},"orderDate":{"type":"string","format":"date-time","description":"The date and time of the purchase order."},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date and time the delivery is expected to arrive."},"supplier":{"type":"string","format":"uri","description":"The URI of the supplier.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"buyer":{"type":"string","format":"uri","description":"The URI of the buyer.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"deliverToLocation":{"type":"string","format":"uri","description":"The URI of the deliver to location.","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderItem"},"description":"List of items included in the purchase order."},"note":{"type":"string","description":"A note to pass any information."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreate"}],"description":"Represents a purchase order."}},"components/schemas/Transactional.PurchaseOrderCreateOrUpdate":{"id":"components/schemas/Transactional.PurchaseOrderCreateOrUpdate","kind":"json-schema","title":"Transactional.PurchaseOrderCreateOrUpdate","data":{"type":"object","required":["number","status","lineItems"],"properties":{"number":{"type":"string","description":"The purchase order number."},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The current status of the purchase order."},"orderDate":{"type":"string","format":"date-time","description":"The date and time of the purchase order."},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date and time the delivery is expected to arrive."},"supplier":{"type":"string","format":"uri","description":"The URI of the supplier.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"buyer":{"type":"string","format":"uri","description":"The URI of the buyer.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"deliverToLocation":{"type":"string","format":"uri","description":"The URI of the deliver to location.","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderItem"},"description":"List of items included in the purchase order."},"note":{"type":"string","description":"A note to pass any information."}},"allOf":[{"$ref":"#/components/schemas/Common.BaseWithIdCreateOrUpdate"}],"description":"Represents a purchase order."}},"components/schemas/Transactional.PurchaseOrderItem":{"id":"components/schemas/Transactional.PurchaseOrderItem","kind":"json-schema","title":"Transactional.PurchaseOrderItem","data":{"type":"object","required":["product","quantity","additionalQuantities"],"properties":{"lineItemId":{"type":"string","description":"An optional line item id."},"product":{"type":"string","format":"uri","description":"The URI of the product for the line item included in the purchase order.","examples":["/organisations/{orgId}/products/{productId}","/organisations/{orgId}/products/{productId}"]},"quantity":{"type":"number","format":"decimal","description":"The quantity of the product included in the purchase order."},"note":{"type":"string","description":"A note for each line item."},"productVariant":{"type":"string","format":"uri","description":"The uri of the product variant if applicable to this purchase order line item.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}","/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"additionalQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."}},"description":"Represents an item that is part of the delivery."}},"components/schemas/Transactional.PurchaseOrderPath":{"id":"components/schemas/Transactional.PurchaseOrderPath","kind":"json-schema","title":"Transactional.PurchaseOrderPath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Transactional.PurchaseOrderPathRecord":{"id":"components/schemas/Transactional.PurchaseOrderPathRecord","kind":"json-schema","title":"Transactional.PurchaseOrderPathRecord","data":{"type":"object","required":["purchaseOrderId"],"properties":{"purchaseOrderId":{"type":"string"}},"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderPath"}]}},"components/schemas/Transactional.PurchaseOrderStatus":{"id":"components/schemas/Transactional.PurchaseOrderStatus","kind":"json-schema","title":"Transactional.PurchaseOrderStatus","data":{"type":"string","enum":["OPEN","APPROVED","COMPLETED","CANCELLED"]}},"components/schemas/Transactional.PurchaseOrderStatusUpdate":{"id":"components/schemas/Transactional.PurchaseOrderStatusUpdate","kind":"json-schema","title":"Transactional.PurchaseOrderStatusUpdate","data":{"type":"object","required":["status"],"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The new status of the purchase order."}},"description":"Update Purchase Order Status"}},"components/schemas/Transactional.UpdateDelivery":{"id":"components/schemas/Transactional.UpdateDelivery","kind":"json-schema","title":"Transactional.UpdateDelivery","data":{"type":"object","required":["deliveryId","from","to","status"],"properties":{"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"to":{"type":"string","format":"uri","description":"The URI of the location to which the delivery is being delivered to.","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The current status of the delivery."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has been delivered."},"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.DeliveryItem"},"description":"List of items included in the delivery."},"agents":{"type":"array","items":{"type":"string"},"description":"List of agent organisation URIs that are associated with the delivery."},"purchaseOrderNumbers":{"type":"array","items":{"type":"string"},"description":"Associated Purchase Orders"},"supplyChainUri":{"type":"string","format":"uri","description":"The URI of the supply chain associated with this delivery."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Transactional.UpdateItem":{"id":"components/schemas/Transactional.UpdateItem","kind":"json-schema","title":"Transactional.UpdateItem","data":{"type":"object","required":["itemId","product","createdAtLocation","currentLocation","created","initialQuantity","additionalInitialQuantities"],"properties":{"itemId":{"type":"string","description":"User defined id for the item."},"product":{"type":"string","format":"uri","description":"URI for the product that the item is.","examples":["/organisations/{orgId}/products/{productId}","/organisations/{orgId}/products/{productId}"]},"createdAtLocation":{"type":"string","format":"uri","description":"URI for the location where the product was created.","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"materials":{"type":"array","items":{"type":"string"},"description":"List of material URIs that are used within the item.","examples":[["/organisations/{orgId}/materials/{materialId}"],["/organisations/{orgId}/materials/{materialId}"]]},"currentLocation":{"type":"string","format":"uri","description":"URI for the location that the item is at or was last at (perhaps it no longer exists as it entered a manufacturing process).","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"created":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.DateTime.DateOrRange"}],"description":"The Date or Date Range that the item was created on."},"initialQuantity":{"type":"number","format":"decimal","description":"This quantity contained within this item at the point when it was created."},"additionalInitialQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."},"remainingQuantity":{"type":"number","format":"decimal","description":"If an item enters a process then this quantity The remaining quantity, some of the item may have been used in a process."},"productVariant":{"type":"string","format":"uri","description":"The uri of the product variant if applicable to this item.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}","/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"batchNumbers":{"type":"array","items":{"type":"string"},"description":"If the item is associated with a particular batch (or multiple batches) then you can use this field to record the batch numbers."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Transactional.UpdateProcess":{"id":"components/schemas/Transactional.UpdateProcess","kind":"json-schema","title":"Transactional.UpdateProcess","data":{"type":"object","required":["processId","type","location","state","firstInputDate","lastOutputDate"],"properties":{"processId":{"type":"string","description":"The process id."},"type":{"type":"string","format":"uri","description":"The URI of the type of process.","examples":["/organisations/{orgId}/process-types/{processTypeId}","/organisations/{orgId}/process-types/{processTypeId}"]},"location":{"type":"string","format":"uri","description":"The URI of the location that this process was carried out at.","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"state":{"allOf":[{"$ref":"#/components/schemas/Transactional.ProcessState"}],"description":"Contains the process state. It governs what you can or cannot do with the process."},"firstInputDate":{"type":"string","format":"date-time","description":"The first date for input."},"lastOutputDate":{"type":"string","format":"date-time","description":"The last date for output."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/Transactional.UpdatePurchaseOrder":{"id":"components/schemas/Transactional.UpdatePurchaseOrder","kind":"json-schema","title":"Transactional.UpdatePurchaseOrder","data":{"type":"object","required":["number","status","lineItems"],"properties":{"number":{"type":"string","description":"The purchase order number."},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The current status of the purchase order."},"orderDate":{"type":"string","format":"date-time","description":"The date and time of the purchase order."},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date and time the delivery is expected to arrive."},"supplier":{"type":"string","format":"uri","description":"The URI of the supplier.","examples":["/organisations/{orgId}/connections/{connectionId}","/organisations/{orgId}/connections/{connectionId}"]},"buyer":{"type":"string","format":"uri","description":"The URI of the buyer.","examples":["/organisations/{orgId}/connections/{connectionId}","/organisations/{orgId}/connections/{connectionId}"]},"deliverToLocation":{"type":"string","format":"uri","description":"The URI of the deliver to location.","examples":["/organisations/{orgId}/locations/{locationId}","/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderItem"},"description":"List of items included in the purchase order."},"note":{"type":"string","description":"A note to pass any information."},"sid":{"type":"string","description":"An identifier you can supply to reference this record by your own id. It is not used by the system and does not need to be unique."}},"description":""}},"components/schemas/TypeSpec.Http.NoContentResponse":{"id":"components/schemas/TypeSpec.Http.NoContentResponse","kind":"json-schema","title":"TypeSpec.Http.NoContentResponse","data":{"type":"object","description":"There is no content to send for this request, but the headers may be useful."}},"components/schemas/Versions":{"id":"components/schemas/Versions","kind":"json-schema","title":"Versions","data":{"type":"string","enum":["v2_25","v2_26","v2_27","v2_28","v2_29","v2_30","v2_31","v2_32","v2_75","v2_79","vNext"]}},"components/schemas/Workflow.BatchInput":{"id":"components/schemas/Workflow.BatchInput","kind":"json-schema","title":"Workflow.BatchInput","data":{"type":"object","required":["product","batchNumber","currentLocation"],"properties":{"product":{"type":"string","format":"uri","description":"The product to use as input.","examples":["/organisations/{orgId}/products/{productId}"]},"variant":{"type":"string","format":"uri","description":"The variant of the product if applicable.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"batchNumber":{"type":"string","description":"The batch number to use to identify the input items."},"currentLocation":{"type":"string","format":"uri","description":"The current location of the items to select from.","examples":["/organisations/{orgId}/locations/{locationId}"]}}}},"components/schemas/Workflow.DDSReference":{"id":"components/schemas/Workflow.DDSReference","kind":"json-schema","title":"Workflow.DDSReference","data":{"type":"object","required":["referenceNumber","verificationNumber"],"properties":{"referenceNumber":{"type":"string","description":"DDS Statement Reference Number"},"verificationNumber":{"type":"string","description":"DDS Reference Verification Number"}}}},"components/schemas/Workflow.DDSRequest":{"id":"components/schemas/Workflow.DDSRequest","kind":"json-schema","title":"Workflow.DDSRequest","data":{"type":"object","properties":{"existing":{"allOf":[{"$ref":"#/components/schemas/Workflow.ExistingDDS"}],"description":"Instruct the workflow on the use of existing DDSs with the delivery creation. This cannot be specified with 'create'"},"create":{"allOf":[{"$ref":"#/components/schemas/Workflow.NewDDS"}],"description":"Instruct the workflow on the generation of a new DDS. This cannot be specified with 'existing'."},"product":{"allOf":[{"$ref":"#/components/schemas/Workflow.ProductDDS"}],"description":"If specified the workflow will assign Predictive Product DDS References to the delivery."}}}},"components/schemas/Workflow.DeliveryConfiguration":{"id":"components/schemas/Workflow.DeliveryConfiguration","kind":"json-schema","title":"Workflow.DeliveryConfiguration","data":{"type":"object","required":["from"],"properties":{"generate":{"type":"boolean","description":"Specify as true if you want to generate a delivery based on this PO. Defaults to false."},"id":{"type":"string","description":"System assigned or user defined id field - if left out then the workflow will use the PO number."},"deliveryId":{"type":"string","description":"User-assigned unique identifier for the delivery - if left out then the workflow will use the PO number."},"from":{"type":"string","format":"uri","description":"The URI of the location from which the delivery is being delivered from.","examples":["/organisations/{orgId}/locations/{locationId}"]},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.DeliveryStatus"}],"description":"The status of the delivery. If left out then it will default to PENDING."},"sent":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been sent."},"delivered":{"type":"string","format":"date-time","description":"The date and time of when the delivery has/will been delivered."}}}},"components/schemas/Workflow.ExistingDDS":{"id":"components/schemas/Workflow.ExistingDDS","kind":"json-schema","title":"Workflow.ExistingDDS","data":{"type":"object","required":["ignoreMissing"],"properties":{"resolve":{"type":"boolean","description":"Resolve and use any DDS's that can be found (equivalent to the Resolve endpoint.)"},"ignoreMissing":{"type":"boolean","description":"If the dds is missing do not fault, carry on. This defaults to false."},"references":{"type":"array","items":{"$ref":"#/components/schemas/Workflow.DDSReference"},"description":"Specify existing DDS References if you want to assign them to this delivery."}}}},"components/schemas/Workflow.ItemOutput":{"id":"components/schemas/Workflow.ItemOutput","kind":"json-schema","title":"Workflow.ItemOutput","data":{"type":"object","required":["itemId","quantity","additionalQuantities"],"properties":{"id":{"type":"string","description":"The record id to assign to the output item."},"itemId":{"type":"string","description":"The item id to assign to the output item."},"quantity":{"type":"integer","format":"int32","description":"The quantity of item to include in the delivery."},"additionalQuantities":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.AdditionalQuantity"},"description":"Additiononal quantities can be specified directly on the item."}}}},"components/schemas/Workflow.ItemsInput":{"id":"components/schemas/Workflow.ItemsInput","kind":"json-schema","title":"Workflow.ItemsInput","data":{"type":"object","required":["item","currentLocation"],"properties":{"item":{"type":"string","format":"uri","description":"The item id to use as input.","examples":["/organisations/{orgId}/items/{itemId}"]},"currentLocation":{"type":"string","format":"uri","description":"The current location of the items to select from.","examples":["/organisations/{orgId}/locations/{locationId}"]}}}},"components/schemas/Workflow.NewDDS":{"id":"components/schemas/Workflow.NewDDS","kind":"json-schema","title":"Workflow.NewDDS","data":{"type":"object","required":["internalReferenceNumber","statementData"],"properties":{"resolve":{"type":"boolean","description":"Resolve and use any DDS's that can be found (equivalent to the Resolve endpoint.)"},"internalReferenceNumber":{"type":"string","description":"An internal reference number that can be user defined to help identify the DDS Reference. If this is the only identifier provided then it is a mandatory field."},"statementData":{"allOf":[{"$ref":"#/components/schemas/CreateDDStatement"}],"description":"Specifies the statement data required to create a DDS based on the created Delivery."}}}},"components/schemas/Workflow.POWorkflowResult":{"id":"components/schemas/Workflow.POWorkflowResult","kind":"json-schema","title":"Workflow.POWorkflowResult","data":{"type":"object","required":["order"],"properties":{"order":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrder"}],"description":"This is the Purchase Order that has been created by the workflow."},"delivery":{"allOf":[{"$ref":"#/components/schemas/Transactional.Delivery"}],"description":"If specified, this is the delivery that was created by the workflow."},"dds":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ResolveDDSResult"},"description":"If the workflow has been called with resolve DDS configuration then it will return any DDSs that it has been able to resolve."},"sharing":{"allOf":[{"$ref":"#/components/schemas/Workflow.SharingResult"}],"description":"If the purchase order was shared with the supplier, this contains the sharing result."}}}},"components/schemas/Workflow.ProcessWorkflowResult":{"id":"components/schemas/Workflow.ProcessWorkflowResult","kind":"json-schema","title":"Workflow.ProcessWorkflowResult","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.Item"},"description":"These are the items that have been created."},"dds":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ResolveDDSResult"},"description":"If the workflow has been called with resolve DDS configuration then it will return any DDSs that it has been able to resolve."}}}},"components/schemas/Workflow.ProductDDS":{"id":"components/schemas/Workflow.ProductDDS","kind":"json-schema","title":"Workflow.ProductDDS","data":{"type":"object","required":["ignoreMissing"],"properties":{"filterBySupplier":{"type":"boolean","description":"If set to true then the supplier must be identified as part of the line items."},"ignoreMissing":{"type":"boolean","description":"If the Product dds is missing do not fault, carry on. This defaults to false."}}}},"components/schemas/Workflow.ProductInput":{"id":"components/schemas/Workflow.ProductInput","kind":"json-schema","title":"Workflow.ProductInput","data":{"type":"object","required":["product","quantity","selectionStrategy","currentLocation"],"properties":{"product":{"type":"string","format":"uri","description":"The product to use as input.","examples":["/organisations/{orgId}/products/{productId}"]},"variant":{"type":"string","format":"uri","description":"The variant of the product if applicable.","examples":["/organisations/{orgId}/products/{productId}/variants/{variantId}"]},"quantity":{"type":"integer","format":"int32","description":"The quantity of product to use."},"selectionStrategy":{"allOf":[{"$ref":"#/components/schemas/Workflow.SelectionStrategy"}],"description":"The selection strategy - First In First Out (FIFO) OR Last In First Out (LIFO)"},"currentLocation":{"type":"string","format":"uri","description":"The current location of the items to select from.","examples":["/organisations/{orgId}/locations/{locationId}"]}}}},"components/schemas/Workflow.ProductOutput":{"id":"components/schemas/Workflow.ProductOutput","kind":"json-schema","title":"Workflow.ProductOutput","data":{"type":"object","required":["product","excludeFromDelivery"],"properties":{"product":{"type":"string","description":"The product that represents the output."},"variant":{"type":"string","description":"The variant of the product if applicable."},"excludeFromDelivery":{"type":"boolean","description":"If you have a by-product of a production process that you do not want to include in the delivery e.g. waste material then exclude this output from the delivery."}},"allOf":[{"$ref":"#/components/schemas/Workflow.ItemOutput"}]}},"components/schemas/Workflow.PurchaseOrderWorkflowRequest":{"id":"components/schemas/Workflow.PurchaseOrderWorkflowRequest","kind":"json-schema","title":"Workflow.PurchaseOrderWorkflowRequest","data":{"type":"object","required":["number","status","lineItems","delivery"],"properties":{"id":{"type":"string","description":"System assigned or user defined id field."},"existingId":{"type":"string","description":"If referencing an existing purchase order, specify its id."},"number":{"type":"string","description":"The purchase order number."},"status":{"allOf":[{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}],"description":"The current status of the purchase order."},"orderDate":{"type":"string","format":"date-time","description":"The date and time of the purchase order."},"expectedDeliveryDate":{"type":"string","format":"date-time","description":"The date and time the delivery is expected."},"supplier":{"type":"string","format":"uri","description":"The URI of the supplier.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"buyer":{"type":"string","format":"uri","description":"The URI of the buyer.","examples":["/organisations/{orgId}/connections/{connectionId}"]},"deliverToLocation":{"type":"string","format":"uri","description":"The URI of the deliver to location.","examples":["/organisations/{orgId}/locations/{locationId}"]},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderItem"},"description":"List of items included in the purchase order."},"note":{"type":"string","description":"A note to pass any information."},"shareWithSupplier":{"type":"boolean","description":"If true, the purchase order will be shared with the supplier."},"delivery":{"allOf":[{"$ref":"#/components/schemas/Workflow.DeliveryConfiguration"}],"description":"Specify delivery configuration if you wish to create a delivery."},"dds":{"allOf":[{"$ref":"#/components/schemas/Workflow.DDSRequest"}],"description":"If specified DDS Statements and/or Reference Numbers can be associated with the PO and (if specified) the created delivery."}}}},"components/schemas/Workflow.SelectionStrategy":{"id":"components/schemas/Workflow.SelectionStrategy","kind":"json-schema","title":"Workflow.SelectionStrategy","data":{"type":"string","enum":["FIFO","LIFO"]}},"components/schemas/Workflow.SharingResult":{"id":"components/schemas/Workflow.SharingResult","kind":"json-schema","title":"Workflow.SharingResult","data":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the sharing operation was successful."},"issues":{"type":"array","items":{"type":"string"},"description":"Any issues encountered during the sharing operation."}}}},"components/schemas/Workflow.WorkflowBasePath":{"id":"components/schemas/Workflow.WorkflowBasePath","kind":"json-schema","title":"Workflow.WorkflowBasePath","data":{"type":"object","required":["orgId"],"properties":{"orgId":{"type":"string","description":"The organisation identity"}}}},"components/schemas/Workflow.WorkflowResult":{"id":"components/schemas/Workflow.WorkflowResult","kind":"json-schema","title":"Workflow.WorkflowResult","data":{"type":"object","required":["delivery"],"properties":{"delivery":{"allOf":[{"$ref":"#/components/schemas/Transactional.Delivery"}],"description":"This is the delivery that has been created by the workflow."},"dds":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ResolveDDSResult"},"description":"If the workflow has been called with resolve DDS configuration then it will return any DDSs that it has been able to resolve."}}}},"components/schemas/iov42.Core.Models.Countries.ISOAlpha2.World":{"id":"components/schemas/iov42.Core.Models.Countries.ISOAlpha2.World","kind":"json-schema","title":"iov42.Core.Models.Countries.ISOAlpha2.World","data":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","VG","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","HK","MO","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}},"components/schemas/iov42.Core.Models.DateTime.DateOrRange":{"id":"components/schemas/iov42.Core.Models.DateTime.DateOrRange","kind":"json-schema","title":"iov42.Core.Models.DateTime.DateOrRange","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXACT","RANGE"],"description":"The type of captured date."},"on":{"type":"string","format":"date-time","description":"If Type is EXACT then this precise date is used."},"start":{"type":"string","format":"date-time","description":"If type is RANGE then this is the start date."},"end":{"type":"string","format":"date-time","description":"If type is RANGE then this is the end date."}}}},"components/schemas/iov42.Core.Models.Geo.Address":{"id":"components/schemas/iov42.Core.Models.Geo.Address","kind":"json-schema","title":"iov42.Core.Models.Geo.Address","data":{"type":"object","required":["country"],"properties":{"street":{"type":"string","description":"The mainline of the address."},"region":{"type":"string","description":"Region of the address."},"zipCode":{"type":"string","description":"Zip/postal code for the address."},"country":{"allOf":[{"$ref":"#/components/schemas/iov42.Core.Models.Countries.ISOAlpha2.World"}],"description":"Alpha-2 code of the ISO 3166 Country Codes specification."}},"description":"Representation of a physical address."}},"components/schemas/iov42.Core.Models.GeoJSON.Feature":{"id":"components/schemas/iov42.Core.Models.GeoJSON.Feature","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.Feature","data":{"type":"object","required":["type","geometry"],"properties":{"type":{"type":"string","enum":["Feature"],"description":"The type of the GeoJSON object."},"geometry":{"anyOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Geometry"},{"type":"null"}],"description":"The geometry of the feature. Can be null."},"id":{"type":"string","description":"An optional identifier for the feature."}},"description":"A GeoJSON Feature object."}},"components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection":{"id":"components/schemas/iov42.Core.Models.GeoJSON.FeatureCollection","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.FeatureCollection","data":{"type":"object","required":["type","features"],"properties":{"type":{"type":"string","enum":["FeatureCollection"],"description":"The type of the GeoJSON object."},"features":{"type":"array","items":{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Feature"},"description":"An array of Feature objects."}},"description":"A collection of GeoJSON Feature objects."}},"components/schemas/iov42.Core.Models.GeoJSON.Geometry":{"id":"components/schemas/iov42.Core.Models.GeoJSON.Geometry","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.Geometry","data":{"anyOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Point"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiPoint"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Polygon"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiPolygon"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.LineString"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiLineString"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.GeometryCollection"}],"description":"A union of all possible GeoJSON geometry types."}},"components/schemas/iov42.Core.Models.GeoJSON.GeometryCollection":{"id":"components/schemas/iov42.Core.Models.GeoJSON.GeometryCollection","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.GeometryCollection","data":{"type":"object","required":["type","geometries"],"properties":{"type":{"type":"string","enum":["GeometryCollection"],"description":"The type of the geometry collection."},"geometries":{"type":"array","items":{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Geometry"},"description":"An array of Geometry objects."}},"description":"A collection of GeoJSON geometry objects."}},"components/schemas/iov42.Core.Models.GeoJSON.LineString":{"id":"components/schemas/iov42.Core.Models.GeoJSON.LineString","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.LineString","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"minItems":2,"description":"An array of two or more positions."}},"description":"GeoJSON LineString geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.MultiLineString":{"id":"components/schemas/iov42.Core.Models.GeoJSON.MultiLineString","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.MultiLineString","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"description":"An array of LineString coordinate arrays."}},"description":"GeoJSON MultiLineString geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.MultiPoint":{"id":"components/schemas/iov42.Core.Models.GeoJSON.MultiPoint","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.MultiPoint","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"An array of positions."}},"description":"GeoJSON MultiPoint geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.MultiPolygon":{"id":"components/schemas/iov42.Core.Models.GeoJSON.MultiPolygon","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.MultiPolygon","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}}},"description":"An array of Polygon coordinate arrays."}},"description":"GeoJSON MultiPolygon geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.Point":{"id":"components/schemas/iov42.Core.Models.GeoJSON.Point","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.Point","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"number","format":"double"},"description":"A single position."}},"description":"GeoJSON Point geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.Polygon":{"id":"components/schemas/iov42.Core.Models.GeoJSON.Polygon","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.Polygon","data":{"type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"],"description":"The type of the geometry."},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"description":"An array of linear ring coordinate arrays."}},"description":"GeoJSON Polygon geometry."}},"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeature":{"id":"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeature","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeature","data":{"type":"object","required":["type","geometry"],"properties":{"type":{"type":"string","enum":["Feature"],"description":"The type of the GeoJSON object."},"geometry":{"anyOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometry"},{"type":"null"}],"description":"The geometry of the feature. Can be null."},"id":{"type":"string","description":"An optional identifier for the feature."}},"description":"A GeoJSON Feature object."}},"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeatureCollection":{"id":"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeatureCollection","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeatureCollection","data":{"type":"object","required":["type","features"],"properties":{"type":{"type":"string","enum":["FeatureCollection"],"description":"The type of the GeoJSON object."},"features":{"type":"array","items":{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateFeature"},"description":"An array of Feature objects."}},"description":"A collection of GeoJSON Feature objects."}},"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometry":{"id":"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometry","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometry","data":{"anyOf":[{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Point"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiPoint"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.Polygon"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiPolygon"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.LineString"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.MultiLineString"},{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometryCollection"}],"description":"A union of all possible GeoJSON geometry types."}},"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometryCollection":{"id":"components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometryCollection","kind":"json-schema","title":"iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometryCollection","data":{"type":"object","required":["type","geometries"],"properties":{"type":{"type":"string","enum":["GeometryCollection"],"description":"The type of the geometry collection."},"geometries":{"type":"array","items":{"$ref":"#/components/schemas/iov42.Core.Models.GeoJSON.UpdateUpdateUpdateGeometry"},"description":"An array of Geometry objects."}},"description":"A collection of GeoJSON geometry objects."}},"components/schemas/iov42.Core.Paging.Page":{"id":"components/schemas/iov42.Core.Paging.Page","kind":"json-schema","title":"iov42.Core.Paging.Page","data":{"type":"object","required":["size","page","totalElements","totalPages"],"properties":{"size":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}}}},"components/schemas/iov42.Core.Responses.NullResponse":{"id":"components/schemas/iov42.Core.Responses.NullResponse","kind":"json-schema","title":"iov42.Core.Responses.NullResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/TypeSpec.Http.NoContentResponse"}]}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Location of the created resource"}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Common.BaseUnitType"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Common.BaseUnit"}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Common.Enums.RecordState"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"default":20},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":0,"default":0},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Common.Standard"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Common.StandardType"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Config.DocumentType"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Config.LocationType"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Config.ProcessType"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Attachment.QueryAttachmentType"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Attachment.QueryTargetType"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","format":"uri"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment.Attachment"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Evidence.Document"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"contentMediaType":"application/octet-stream"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.Credential"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Integrations.Eudr.DDSStatus"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Integrations.Eudr.SourceResourceType"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.DDSReference"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.DDSRecord"}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Integrations.Eudr.ResolveDDSResult"}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/Create_DDS_From_Products"},{"$ref":"#/components/schemas/Create_DDS_From_Other"}]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Static.ConnectStatus"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.Connection"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Static.QueryLinkDirection"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.LocationLink"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.Location"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.Material"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Common.Enums.BaseUnitType"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Common.Enums.BaseUnitType"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.Product"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Static.Variant"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Transactional.DeliveryStatus"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.Delivery"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.Item"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrderStatus"}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.PurchaseOrder"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.Process"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessInput"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","required":["content","page"],"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transactional.ProcessOutput"}},"page":{"$ref":"#/components/schemas/iov42.Core.Paging.Page"}}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/Create_Trade_Delivery_From_Items"},{"$ref":"#/components/schemas/Create_Trade_Delivery_From_Batches"},{"$ref":"#/components/schemas/Create_Trade_Delivery_From_Products"},{"$ref":"#/components/schemas/Create_Production_Delivery_From_Items"},{"$ref":"#/components/schemas/Create_Production_Delivery_From_Batches"},{"$ref":"#/components/schemas/Create_Production_Delivery_From_Products"}]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/Create_Process_From_Items"},{"$ref":"#/components/schemas/Create_Process_From_Batches"},{"$ref":"#/components/schemas/Create_Process_From_Products"}]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/OutboundSends.SendRecord"}},"id":"schema_50"}},"exampleStore":{},"securitySchemeStore":{"InteruAuth":{"id":"InteruAuth","type":"apiKey","in":"header","paramName":"X-API-Key"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/reference/api","isMockServer":true,"description":"Mock server"},{"url":"https://api.uat.interu.io","description":"UAT"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/reference/api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/api.json?download"},{"url":"/_bundle/reference/api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Interu API"}},"baseSlug":"/reference/api","routesMapping":{}}