{"items":[{"type":"link","label":"PTV OptiFlow Resources API","link":"/apis/resource-management/resources-api","routeSlug":"/apis/resource-management/resources-api","content":{"contentType":"overview","meta":{"name":"PTV OptiFlow Resources API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"resources-api.json","url":"/_bundle/apis/resource-management/resources-api.json?download"},{"kind":"download","label":"resources-api.yaml","url":"/_bundle/apis/resource-management/resources-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://servicedesk.conundra.eu","url":"https://servicedesk.conundra.eu"}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"PTV OptiFlow Resources API (1.30.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Resources API provides the resources necessary to create a planning."}],"sectionId":"/apis/resource-management/resources-api"}],"sectionId":"/apis/resource-management/resources-api"}]}]}},{"type":"separator","label":"Health","content":null},{"type":"group","label":"Health check","link":"/apis/resource-management/resources-api/health","routeSlug":"/apis/resource-management/resources-api/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/health/ping","routeSlug":"/apis/resource-management/resources-api/health/ping","metadata":{"seo":{"title":"Health check","description":"The ping-endpoint can be used for validating a connection with the application. It will authenticate the caller and respond pong if everything is set-up correctly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Health check","isWebhook":false,"pointer":"/paths/~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check","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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-endpoint can be used for validating a connection with the application. It will authenticate the caller and respond "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pong"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if everything is set-up correctly."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ping","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/ping","href":"health/ping","openApiOperationId":"ping","summary":"Health check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returned when the application is responsive and you are authenticated.","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"]},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"]}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/ping"}],"content":{"contentType":"group","meta":{"name":"health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check","showPageActions":true},{"nodeType":"markdoc","content":"Miscellaneous endpoints for general API functionality"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ping","summary":"Health check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/ping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Employee Management","content":null},{"type":"group","label":"Employee","link":"/apis/resource-management/resources-api/employee","routeSlug":"/apis/resource-management/resources-api/employee","items":[{"label":"Get cursor-based employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee/getpagedemployees","routeSlug":"/apis/resource-management/resources-api/employee/getpagedemployees","metadata":{"seo":{"title":"Get cursor-based employees","description":"Retrieve employees in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedEmployees","name":"Get cursor-based employees","isWebhook":false,"pointer":"/paths/~1employee/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cursor-based employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve employees in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_0","description":"The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.\n"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Number of results to return per page.\n"}],"pointer":"/paths/~1employee/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/employee","href":"employee/getpagedemployees","openApiOperationId":"getPagedEmployees","summary":"Get cursor-based employees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The results for the current paged request and optional pointers to related result pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedEmployees"}},"schemaId":"components/schemas/CursorPagedEmployees"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1employee/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagedEmployees","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedEmployees"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/employee"},{"label":"Upsert Employee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee/upsertemployee","routeSlug":"/apis/resource-management/resources-api/employee/upsertemployee","metadata":{"seo":{"title":"Upsert Employee","description":"Create or update an Employee. A unique ID is required to identify the Employee. Calling this endpoint with an existing id will update the Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertEmployee","name":"Upsert Employee","isWebhook":false,"pointer":"/paths/~1employee~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Employee","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":"Create or update an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A unique ID is required to identify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calling this endpoint with an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifying (or retrieving) an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will provide the caller with a version number for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This version can be passed to the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upsert"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak ETag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"If-Match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. This allows the caller to ensure that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been modified since the last time it was retrieved."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should only contain characters which do not need URL encoding."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee","pointer":"/paths/~1employee~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employee/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Employee"}},"responseCodes":["201","204","400","401","404","409","412"],"pointer":"/employee/{id}","href":"employee/upsertemployee","openApiOperationId":"upsertEmployee","summary":"Upsert Employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Employee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Employee created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Employee created or updated","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{id}"},{"label":"Get Employee by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee/getemployee","routeSlug":"/apis/resource-management/resources-api/employee/getemployee","metadata":{"seo":{"title":"Get Employee by id","description":"Get an existing Employee, defined by their id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployee","name":"Get Employee by id","isWebhook":false,"pointer":"/paths/~1employee~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Employee by id","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":"Get an existing Employee, defined by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID used to identify this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/employee/{id}","href":"employee/getemployee","openApiOperationId":"getEmployee","summary":"Get Employee by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successfully retrieved. Details are in the response body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{id}"},{"label":"Delete Employee by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee/deleteemployee","routeSlug":"/apis/resource-management/resources-api/employee/deleteemployee","metadata":{"seo":{"title":"Delete Employee by id","description":"Delete an Employee, defined by their id. Removing an Employee will remove all related sub-resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployee","name":"Delete Employee by id","isWebhook":false,"pointer":"/paths/~1employee~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Employee by id","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":"Delete an Employee, defined by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Removing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove all related sub-resources."},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deployed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (eg: used in a released route in an optimization) will not be removed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1employee~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employee/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","412"],"pointer":"/employee/{id}","href":"employee/deleteemployee","openApiOperationId":"deleteEmployee","summary":"Delete Employee by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty. Sub-resources will be removed asynchronously.\n"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{id}"}],"content":{"contentType":"group","meta":{"name":"employee"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employee","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints used for managing the general information regarding your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These endpoints are meant for managing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose role is relevant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the functionality in Resource Management, ie: typically only those "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" capable of operating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/resource-management/domain/#employee","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employee","summary":"Get cursor-based employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee/getpagedemployees","deprecated":false},{"title":"/employee/{id}","summary":"Upsert Employee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employee/upsertemployee","deprecated":false},{"title":"/employee/{id}","summary":"Get Employee by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee/getemployee","deprecated":false},{"title":"/employee/{id}","summary":"Delete Employee by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employee/deleteemployee","deprecated":false}]}]}]}]}},{"type":"group","label":"Shift Schedule","link":"/apis/resource-management/resources-api/shift-schedule","routeSlug":"/apis/resource-management/resources-api/shift-schedule","items":[{"label":"Create Shift Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/shift-schedule/createshiftschedule","routeSlug":"/apis/resource-management/resources-api/shift-schedule/createshiftschedule","metadata":{"seo":{"title":"Create Shift Schedule","description":"Endpoint to create a ShiftSchedule. An identifier will be generated by the application. This identifier can be retrieved from the Location header, orresponse body (if the Prefer header is set to return=representation)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShiftSchedule","name":"Create Shift Schedule","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Shift Schedule","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":"Endpoint to create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An identifier will be generated by the application. This identifier can be retrieved from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response body (if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prefer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=representation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"schemaId":"components/schemas/ShiftSchedule","pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employee/{employee_id}/shift-schedule","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"responseCodes":["201","204","400","401","404","409"],"pointer":"/employee/{employee_id}/shift-schedule","href":"shift-schedule/createshiftschedule","openApiOperationId":"createShiftSchedule","summary":"Create Shift Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/ShiftSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Shift Schedule created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"schemaId":"components/schemas/ShiftSchedule","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Shift Schedule created","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ShiftSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/shift-schedule"},{"label":"Get all Shift Schedules by Employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/shift-schedule/getshiftschedulesbyemployeeid","routeSlug":"/apis/resource-management/resources-api/shift-schedule/getshiftschedulesbyemployeeid","metadata":{"seo":{"title":"Get all Shift Schedules by Employee","description":"Retrieve all ShiftSchedules for a given Employee, identified by their id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShiftSchedulesByEmployeeId","name":"Get all Shift Schedules by Employee","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Shift Schedules by Employee","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":"Retrieve all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by their id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{employee_id}/shift-schedule","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/employee/{employee_id}/shift-schedule","href":"shift-schedule/getshiftschedulesbyemployeeid","openApiOperationId":"getShiftSchedulesByEmployeeId","summary":"Get all Shift Schedules by Employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". List may be empty if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" were found."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedules"}},"schemaId":"components/schemas/ShiftSchedules"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ShiftSchedules","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedules"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/shift-schedule"},{"label":"Update Shift Schedule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/shift-schedule/updateshiftschedule","routeSlug":"/apis/resource-management/resources-api/shift-schedule/updateshiftschedule","metadata":{"seo":{"title":"Update Shift Schedule","description":"Update an existing ShiftSchedule for an Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShiftSchedule","name":"Update Shift Schedule","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Shift Schedule","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":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is determined by the application and was returned on creation. A list of existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be retrieved by using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getShiftSchedulesByEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for."},"children":[]}]}]}],"required":true},{"name":"generated_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"schemaId":"components/schemas/ShiftSchedule","pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employee/{employee_id}/shift-schedule/{generated_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"generated_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/employee/{employee_id}/shift-schedule/{generated_id}","href":"shift-schedule/updateshiftschedule","openApiOperationId":"updateShiftSchedule","summary":"Update Shift Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/ShiftSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Shift Schedule updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}},"schemaId":"components/schemas/ShiftSchedule","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Shift Schedule updated","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ShiftSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ShiftSchedule"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/shift-schedule/{generated_id}"},{"label":"Delete Shift Schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/shift-schedule/deleteshiftschedule","routeSlug":"/apis/resource-management/resources-api/shift-schedule/deleteshiftschedule","metadata":{"seo":{"title":"Delete Shift Schedule","description":"Update an existing ShiftSchedule for an Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShiftSchedule","name":"Delete Shift Schedule","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Shift Schedule","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":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is determined by the application and was returned on creation. A list of existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be retrieved by using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getShiftSchedulesByEmployeeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delete this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for."},"children":[]}]}]}],"required":true},{"name":"generated_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employee/{employee_id}/shift-schedule/{generated_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"generated_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","404","412"],"pointer":"/employee/{employee_id}/shift-schedule/{generated_id}","href":"shift-schedule/deleteshiftschedule","openApiOperationId":"deleteShiftSchedule","summary":"Delete Shift Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1shift-schedule~1{generated_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/shift-schedule/{generated_id}"}],"content":{"contentType":"group","meta":{"name":"shift-schedule"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shift Schedule","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to describe the recurring pattern for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s availability. They do not trigger availabilities themselves, but can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used to generate availabilities according to this schedule, through the application's user interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enables planners to do long-term planning using the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Employee Overview"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the UI, since this allows us to predict when an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" be available."},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/resource-management/domain/#shift-schedule","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employee/{employee_id}/shift-schedule","summary":"Create Shift Schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shift-schedule/createshiftschedule","deprecated":false},{"title":"/employee/{employee_id}/shift-schedule","summary":"Get all Shift Schedules by Employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shift-schedule/getshiftschedulesbyemployeeid","deprecated":false},{"title":"/employee/{employee_id}/shift-schedule/{generated_id}","summary":"Update Shift Schedule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shift-schedule/updateshiftschedule","deprecated":false},{"title":"/employee/{employee_id}/shift-schedule/{generated_id}","summary":"Delete Shift Schedule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/shift-schedule/deleteshiftschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Availability","link":"/apis/resource-management/resources-api/availability","routeSlug":"/apis/resource-management/resources-api/availability","items":[{"label":"Get all Employee Availabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/getemployeeavailabilities","routeSlug":"/apis/resource-management/resources-api/availability/getemployeeavailabilities","metadata":{"seo":{"title":"Get all Employee Availabilities","description":"Retrieves all Availabilities for a single Employee (identified by their id) within an optional time range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployeeAvailabilities","name":"Get all Employee Availabilities","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Employee Availabilities","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":"Retrieves all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (identified by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") within an optional time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint will return any "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overlapping"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so it is possible for the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to have a time range that spills outside"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the provided time range. Overlap is determined for the widest possible range on an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability, ie: "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"earliest_start"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up until (calculated)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latest_stop`."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When providing a time range, it can be open (either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided) or closed (both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whom to retrieve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start of the time range to retrieve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for. If not provided, the time range will be open-ended, starting from the earliest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2021-01-01T10:15:30Z"},{"name":"until","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end of the time range to retrieve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for. If not provided, the time range will be open-ended, ending at the latest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, until must not be lower than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2021-01-05T10:15:30Z"}],"pointer":"/paths/~1employee~1{employee_id}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{employee_id}/availability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"from","in":"query","required":false,"example":"2021-01-01T10:15:30Z","schemaId":"schema_8"},{"name":"until","in":"query","required":false,"example":"2021-01-05T10:15:30Z","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/employee/{employee_id}/availability","href":"availability/getemployeeavailabilities","openApiOperationId":"getEmployeeAvailabilities","summary":"Get all Employee Availabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that overlap with the provided time range. This list can be empty. Each item contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optimistic locking purposes."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availabilities"}},"schemaId":"components/schemas/Availabilities"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Availabilities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availabilities"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability"},{"label":"Create Employee Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/addemployeeavailability","routeSlug":"/apis/resource-management/resources-api/availability/addemployeeavailability","metadata":{"seo":{"title":"Create Employee Availability","description":"Add an Availability for an Employee. An identifier will be generated by the application. This identifier can be retrieved from the Location header,or response body (if the Prefer header is set to return=representation)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addEmployeeAvailability","name":"Create Employee Availability","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Employee Availability","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":"Add an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An identifier will be generated by the application. This identifier can be retrieved from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or response body (if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prefer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=representation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not overlap with existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whom to create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}}],"pointer":"/paths/~1employee~1{employee_id}~1availability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Availability"}},"schemaId":"components/schemas/Availability","pointer":"/paths/~1employee~1{employee_id}~1availability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employee/{employee_id}/availability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Availability"}},"responseCodes":["201","204","400","401","404","409"],"pointer":"/employee/{employee_id}/availability","href":"availability/addemployeeavailability","openApiOperationId":"addEmployeeAvailability","summary":"Create Employee Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/Availability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Availability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Availability created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}},"schemaId":"components/schemas/Availability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Availability created","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Availability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability"},{"label":"Delete Employee Availabilities","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/deleteemployeeavailabilities","routeSlug":"/apis/resource-management/resources-api/availability/deleteemployeeavailabilities","metadata":{"seo":{"title":"Delete Employee Availabilities","description":"Delete all existing Employee Availabilities that overlap using an open or closed a time range. Overlap is determined for the widest possible range onan Availability, ie: earliest_startup until (calculated)latest_stop`."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployeeAvailabilities","name":"Delete Employee Availabilities","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Employee Availabilities","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":"Delete all existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that overlap using an open or closed a time range. Overlap is determined for the widest possible range on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability, ie: "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"earliest_start"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up until (calculated)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latest_stop`."},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Any "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overlapping"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities will be removed, an "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability` can be partially outside of the provided time range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_8","example":"2021-01-01T10:15:30Z"},{"name":"until","in":"query","schemaId":"schema_8","example":"2021-01-05T10:15:30Z"}],"pointer":"/paths/~1employee~1{employee_id}~1availability/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employee/{employee_id}/availability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"from","in":"query","required":false,"example":"2021-01-01T10:15:30Z","schemaId":"schema_8"},{"name":"until","in":"query","required":false,"example":"2021-01-05T10:15:30Z","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/employee/{employee_id}/availability","href":"availability/deleteemployeeavailabilities","openApiOperationId":"deleteEmployeeAvailabilities","summary":"Delete Employee Availabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability"},{"label":"Get Employee Availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/getemployeeavailability","routeSlug":"/apis/resource-management/resources-api/availability/getemployeeavailability","metadata":{"seo":{"title":"Get Employee Availability","description":"Retrieve an existing Availability, identified by its generated_id, for an Employee, identified by their id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployeeAvailability","name":"Get Employee Availability","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Employee Availability","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":"Retrieve an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whom to retrieve an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"generated_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{employee_id}/availability/{generated_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"generated_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/employee/{employee_id}/availability/{generated_id}","href":"availability/getemployeeavailability","openApiOperationId":"getEmployeeAvailability","summary":"Get Employee Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employee Availability is retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}},"schemaId":"components/schemas/Availability","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Availability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability/{generated_id}"},{"label":"Update Employee Availability","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/updateemployeeavailability","routeSlug":"/apis/resource-management/resources-api/availability/updateemployeeavailability","metadata":{"seo":{"title":"Update Employee Availability","description":"Update a specific Availability, identified by its generated_id, for an Employee, identified by their id. The updated Availability shouldnot overlap with existing Availabilities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEmployeeAvailability","name":"Update Employee Availability","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Employee Availability","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":"Update a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The updated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not overlap with existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whom to update an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"generated_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Availability"}},"schemaId":"components/schemas/Availability","pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employee/{employee_id}/availability/{generated_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"generated_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Availability"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/employee/{employee_id}/availability/{generated_id}","href":"availability/updateemployeeavailability","openApiOperationId":"updateEmployeeAvailability","summary":"Update Employee Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/Availability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Availability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Availability updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}},"schemaId":"components/schemas/Availability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Availability updated.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Availability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Availability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability/{generated_id}"},{"label":"Delete Employee Availability by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/availability/deleteemployeeavailability","routeSlug":"/apis/resource-management/resources-api/availability/deleteemployeeavailability","metadata":{"seo":{"title":"Delete Employee Availability by id","description":"Delete an existing Availability, identified by its generated_id, for an Employee, identified by their id. This will remove a ResourceCombinationtied to this Availability if it was not deployed by releasing a route in an optimization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployeeAvailability","name":"Delete Employee Availability by id","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Employee Availability by id","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":"Delete an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generated_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", identified by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This will remove a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tied to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it was not deployed by releasing a route in an optimization."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for whom to delete an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"generated_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employee/{employee_id}/availability/{generated_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"generated_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","404","412"],"pointer":"/employee/{employee_id}/availability/{generated_id}","href":"availability/deleteemployeeavailability","openApiOperationId":"deleteEmployeeAvailability","summary":"Delete Employee Availability by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1availability~1{generated_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/availability/{generated_id}"}],"content":{"contentType":"group","meta":{"name":"availability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Availability","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define a specific time range during which an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is available to execute tasks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These can either be derived from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via the user interface) or created on an ad-hoc basis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created or updated, it triggers a consolidation process that generates a snapshot of the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at that moment, referred to as an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AvailableEmployee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This snapshot accounts for relocations (managed through the user interface) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ensuring a single source of truth for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s status at that point in time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any modifications to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AvailableEmployee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" snapshot activate an algorithm that evaluates potential "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" involving the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During this evaluation, potential "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are assessed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the heuristic identifies that a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would enhance the overall solution's fitness, it is either created or updated."},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://developer.conundra.eu/developer-portal/resource-management/domain/#availability","description":"Find out more"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employee/{employee_id}/availability","summary":"Get all Employee Availabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/availability/getemployeeavailabilities","deprecated":false},{"title":"/employee/{employee_id}/availability","summary":"Create Employee Availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/availability/addemployeeavailability","deprecated":false},{"title":"/employee/{employee_id}/availability","summary":"Delete Employee Availabilities","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/availability/deleteemployeeavailabilities","deprecated":false},{"title":"/employee/{employee_id}/availability/{generated_id}","summary":"Get Employee Availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/availability/getemployeeavailability","deprecated":false},{"title":"/employee/{employee_id}/availability/{generated_id}","summary":"Update Employee Availability","prefix":{"name":"put","color":"put"},"badges":[],"link":"/availability/updateemployeeavailability","deprecated":false},{"title":"/employee/{employee_id}/availability/{generated_id}","summary":"Delete Employee Availability by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/availability/deleteemployeeavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Unavailability [EXPERIMENTAL]","link":"/apis/resource-management/resources-api/employee-unavailability","routeSlug":"/apis/resource-management/resources-api/employee-unavailability","items":[{"label":"[EXPERIMENTAL] Create Employee Unavailability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee-unavailability/createemployeeunavailability","routeSlug":"/apis/resource-management/resources-api/employee-unavailability/createemployeeunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Create Employee Unavailability","description":"Create an unavailability for an employee, without providing an identifier. The generated identifier will be available in the response's Locationheader, and/or response body if the appropriate Prefer-header is provided with the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmployeeUnavailability","name":"[EXPERIMENTAL] Create Employee Unavailability","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1unavailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Create Employee Unavailability","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":"Create an unavailability for an employee, without providing an identifier. The generated identifier will be available in the response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header, and/or response body if the appropriate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prefer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-header is provided with the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"schemaId":"components/schemas/EmployeeUnavailability","pointer":"/paths/~1employee~1{employee_id}~1unavailability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employee/{employee_id}/unavailability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/employee/{employee_id}/unavailability","href":"employee-unavailability/createemployeeunavailability","openApiOperationId":"createEmployeeUnavailability","summary":"[EXPERIMENTAL] Create Employee Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/EmployeeUnavailability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Employee Unavailability created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"schemaId":"components/schemas/EmployeeUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Employee Unavailability created","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmployeeUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/unavailability"},{"label":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee-unavailability/getemployeeunavailabilities","routeSlug":"/apis/resource-management/resources-api/employee-unavailability/getemployeeunavailabilities","metadata":{"seo":{"title":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id","description":"Get all Employee Unavailabilities by Employee id. When a from and until are provided, we match any Unavailabilities that overlap with this range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployeeUnavailabilities","name":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1unavailability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id","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":"Get all Employee Unavailabilities by Employee id. When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, we match any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that overlap with this range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_8","example":"2021-01-01T10:15:30Z"},{"name":"until","in":"query","schemaId":"schema_8","example":"2021-01-05T10:15:30Z"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{employee_id}/unavailability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"from","in":"query","required":false,"example":"2021-01-01T10:15:30Z","schemaId":"schema_8"},{"name":"until","in":"query","required":false,"example":"2021-01-05T10:15:30Z","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/employee/{employee_id}/unavailability","href":"employee-unavailability/getemployeeunavailabilities","openApiOperationId":"getEmployeeUnavailabilities","summary":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employee Unavailabilities are retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailabilities"}},"schemaId":"components/schemas/EmployeeUnavailabilities"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmployeeUnavailabilities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailabilities"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/unavailability"},{"label":"[EXPERIMENTAL] Upsert Employee Unavailability","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee-unavailability/upsertemployeeunavailability","routeSlug":"/apis/resource-management/resources-api/employee-unavailability/upsertemployeeunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert Employee Unavailability","description":"Create or update an unavailability for an employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertEmployeeUnavailability","name":"[EXPERIMENTAL] Upsert Employee Unavailability","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert Employee Unavailability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update an unavailability for an employee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"schemaId":"components/schemas/EmployeeUnavailability","pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/employee/{employee_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"responseCodes":["201","204","400","401","404"],"pointer":"/employee/{employee_id}/unavailability/{unavailability_id}","href":"employee-unavailability/upsertemployeeunavailability","openApiOperationId":"upsertEmployeeUnavailability","summary":"[EXPERIMENTAL] Upsert Employee Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/EmployeeUnavailability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Employee Unavailability created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"schemaId":"components/schemas/EmployeeUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Employee Unavailability created or updated.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmployeeUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/unavailability/{unavailability_id}"},{"label":"[EXPERIMENTAL] Delete Employee Unavailability by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee-unavailability/deleteemployeeunavailability","routeSlug":"/apis/resource-management/resources-api/employee-unavailability/deleteemployeeunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete Employee Unavailability by id","description":"[EXPERIMENTAL] Delete Employee Unavailability by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmployeeUnavailability","name":"[EXPERIMENTAL] Delete Employee Unavailability by id","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete Employee Unavailability by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/employee/{employee_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","412"],"pointer":"/employee/{employee_id}/unavailability/{unavailability_id}","href":"employee-unavailability/deleteemployeeunavailability","openApiOperationId":"deleteEmployeeUnavailability","summary":"[EXPERIMENTAL] Delete Employee Unavailability by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Employee Unavailability deleted"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/unavailability/{unavailability_id}"},{"label":"[EXPERIMENTAL] Get Employee Unavailability by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/employee-unavailability/getemployeeunavailability","routeSlug":"/apis/resource-management/resources-api/employee-unavailability/getemployeeunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Get Employee Unavailability by id","description":"[EXPERIMENTAL] Get Employee Unavailability by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmployeeUnavailability","name":"[EXPERIMENTAL] Get Employee Unavailability by id","isWebhook":false,"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get Employee Unavailability by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_2","description":"A unique identifier of an Employee. Should only contain characters which do not need URL encoding.","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/employee/{employee_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/employee/{employee_id}/unavailability/{unavailability_id}","href":"employee-unavailability/getemployeeunavailability","openApiOperationId":"getEmployeeUnavailability","summary":"[EXPERIMENTAL] Get Employee Unavailability by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Employee Unavailability retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}},"schemaId":"components/schemas/EmployeeUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1employee~1{employee_id}~1unavailability~1{unavailability_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmployeeUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeUnavailability"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/employee/{employee_id}/unavailability/{unavailability_id}"}],"content":{"contentType":"group","meta":{"name":"employee-unavailability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unavailability [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define a specific time range during which an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unavailable to execute tasks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be due to sickness, holiday, or other temporary absences."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During its duration, the employee can not be matched with a transport resource and used as part of the planning."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employee/{employee_id}/unavailability","summary":"[EXPERIMENTAL] Create Employee Unavailability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employee-unavailability/createemployeeunavailability","deprecated":false},{"title":"/employee/{employee_id}/unavailability","summary":"[EXPERIMENTAL] Get all Employee Unavailabilities by Employee id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee-unavailability/getemployeeunavailabilities","deprecated":false},{"title":"/employee/{employee_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Upsert Employee Unavailability","prefix":{"name":"put","color":"put"},"badges":[],"link":"/employee-unavailability/upsertemployeeunavailability","deprecated":false},{"title":"/employee/{employee_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Delete Employee Unavailability by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employee-unavailability/deleteemployeeunavailability","deprecated":false},{"title":"/employee/{employee_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Get Employee Unavailability by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employee-unavailability/getemployeeunavailability","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transport Resource Management","content":null},{"type":"group","label":"Transport Resource","link":"/apis/resource-management/resources-api/transport-resource","routeSlug":"/apis/resource-management/resources-api/transport-resource","items":[{"label":"Get cursor-based transport resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource/getpagedtransportresources","routeSlug":"/apis/resource-management/resources-api/transport-resource/getpagedtransportresources","metadata":{"seo":{"title":"Get cursor-based transport resources","description":"Retrieve transport resources in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedTransportResources","name":"Get cursor-based transport resources","isWebhook":false,"pointer":"/paths/~1transport-resource/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cursor-based transport resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve transport resources in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_0","description":"The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.\n"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Number of results to return per page.\n"}],"pointer":"/paths/~1transport-resource/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-resource","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/transport-resource","href":"transport-resource/getpagedtransportresources","openApiOperationId":"getPagedTransportResources","summary":"Get cursor-based transport resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The results for the current paged request and optional pointers to related result pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedTransportResources"}},"schemaId":"components/schemas/CursorPagedTransportResources"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1transport-resource/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagedTransportResources","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedTransportResources"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/transport-resource"},{"label":"Upsert Transport Resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource/upserttransportresource","routeSlug":"/apis/resource-management/resources-api/transport-resource/upserttransportresource","metadata":{"seo":{"title":"Upsert Transport Resource","description":"Upsert a single TransportResource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertTransportResource","name":"Upsert Transport Resource","isWebhook":false,"pointer":"/paths/~1transport-resource~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert Transport Resource","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":"Upsert a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is considered to be always available unless a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResourceUnavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" says otherwise, its presence will result in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application trying to create "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AvailableEmployees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1transport-resource~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1transport-resource~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResource"}},"schemaId":"components/schemas/TransportResource","pointer":"/paths/~1transport-resource~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-resource/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransportResource"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/transport-resource/{id}","href":"transport-resource/upserttransportresource","openApiOperationId":"upsertTransportResource","summary":"Upsert Transport Resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/TransportResource","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResource"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transport Resource created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResource"}},"schemaId":"components/schemas/TransportResource","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Transport Resource created or updated","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransportResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResource"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{id}"},{"label":"Get Transport Resource by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource/gettransportresource","routeSlug":"/apis/resource-management/resources-api/transport-resource/gettransportresource","metadata":{"seo":{"title":"Get Transport Resource by id","description":"Get an existing TransportResource"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransportResource","name":"Get Transport Resource by id","isWebhook":false,"pointer":"/paths/~1transport-resource~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transport Resource by id","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":"Get an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1transport-resource~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-resource/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/transport-resource/{id}","href":"transport-resource/gettransportresource","openApiOperationId":"getTransportResource","summary":"Get Transport Resource by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transport Resource is retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResource"}},"schemaId":"components/schemas/TransportResource","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransportResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResource"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{id}"},{"label":"Delete Transport Resource by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource/deletetransportresource","routeSlug":"/apis/resource-management/resources-api/transport-resource/deletetransportresource","metadata":{"seo":{"title":"Delete Transport Resource by id","description":"Delete an existing TransportResource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTransportResource","name":"Delete Transport Resource by id","isWebhook":false,"pointer":"/paths/~1transport-resource~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Transport Resource by id","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":"Delete an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon deleting, the application will also remove ResourceCombinations using this TransportResource and try to find replacements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All unavailabilities and relocations related to this TransportResource will be removed as well."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1transport-resource~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1transport-resource~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-resource/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","412"],"pointer":"/transport-resource/{id}","href":"transport-resource/deletetransportresource","openApiOperationId":"deleteTransportResource","summary":"Delete Transport Resource by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty\n"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{id}"}],"content":{"contentType":"group","meta":{"name":"transport-resource"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transport Resource","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints used for managing the general information regarding your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transport Resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Trucks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Trailers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tractors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-resource","summary":"Get cursor-based transport resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-resource/getpagedtransportresources","deprecated":false},{"title":"/transport-resource/{id}","summary":"Upsert Transport Resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transport-resource/upserttransportresource","deprecated":false},{"title":"/transport-resource/{id}","summary":"Get Transport Resource by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-resource/gettransportresource","deprecated":false},{"title":"/transport-resource/{id}","summary":"Delete Transport Resource by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transport-resource/deletetransportresource","deprecated":false}]}]}]}]}},{"type":"group","label":"Unavailability [EXPERIMENTAL]","link":"/apis/resource-management/resources-api/transport-resource-unavailability","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability","items":[{"label":"[EXPERIMENTAL] Create TransportResource Unavailability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource-unavailability/addtransportresourceunavailability","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability/addtransportresourceunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Create TransportResource Unavailability","description":"This endpoint allows you to create an Unavailability with a generated ID. This can be used for ad hocUnavailabilities or situations where the source system does not contain any unique IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTransportResourceUnavailability","name":"[EXPERIMENTAL] Create TransportResource Unavailability","isWebhook":false,"pointer":"/paths/~1transport-resource~1{id}~1unavailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Create TransportResource Unavailability","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":"This endpoint allows you to create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This can be used for "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ad hoc"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or situations where the source system does not contain any unique IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the PUT operation for more information on the functional impact of adding a new unavailability."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"schemaId":"components/schemas/TransportResourceUnavailability","pointer":"/paths/~1transport-resource~1{id}~1unavailability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transport-resource/{id}/unavailability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"responseCodes":["201","204","400","401","404"],"pointer":"/transport-resource/{id}/unavailability","href":"transport-resource-unavailability/addtransportresourceunavailability","openApiOperationId":"addTransportResourceUnavailability","summary":"[EXPERIMENTAL] Create TransportResource Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/TransportResourceUnavailability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Unavailability created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"schemaId":"components/schemas/TransportResourceUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Unavailability created","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransportResourceUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{id}/unavailability"},{"label":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource-unavailability/gettransportresourceunavailabilities","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability/gettransportresourceunavailabilities","metadata":{"seo":{"title":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id","description":"Get all TransportResource Unavailabilities by TransportResource id. When a from and until are provided, we match any Unavailabilities that overlap with this range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransportResourceUnavailabilities","name":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id","isWebhook":false,"pointer":"/paths/~1transport-resource~1{id}~1unavailability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id","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":"Get all TransportResource Unavailabilities by TransportResource id. When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are provided, we match any "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that overlap with this range."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_8","example":"2021-01-01T10:15:30Z"},{"name":"until","in":"query","schemaId":"schema_8","example":"2021-01-05T10:15:30Z"}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-resource/{id}/unavailability","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"from","in":"query","required":false,"example":"2021-01-01T10:15:30Z","schemaId":"schema_8"},{"name":"until","in":"query","required":false,"example":"2021-01-05T10:15:30Z","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/transport-resource/{id}/unavailability","href":"transport-resource-unavailability/gettransportresourceunavailabilities","openApiOperationId":"getTransportResourceUnavailabilities","summary":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transport Resource is retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailabilities"}},"schemaId":"components/schemas/TransportResourceUnavailabilities"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{id}~1unavailability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransportResourceUnavailabilities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailabilities"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{id}/unavailability"},{"label":"[EXPERIMENTAL] Upsert TransportResource Unavailability","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource-unavailability/upserttransportresourceunavailability","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability/upserttransportresourceunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert TransportResource Unavailability","description":"Create or update a TransportResourceUnavailability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertTransportResourceUnavailability","name":"[EXPERIMENTAL] Upsert TransportResource Unavailability","isWebhook":false,"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert TransportResource Unavailability","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":"Create or update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResourceUnavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes unavailable, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose guaranteed working time overlapped with the unavailability are deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For other overlaps the existing combinations are only re-evaluated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transport_resource_id","in":"path","schemaId":"schema_2","description":"the business id of the TransportResource for which to add an unavailability","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"schemaId":"components/schemas/TransportResourceUnavailability","pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"transport_resource_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"responseCodes":["201","204","400","401","404"],"pointer":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","href":"transport-resource-unavailability/upserttransportresourceunavailability","openApiOperationId":"upsertTransportResourceUnavailability","summary":"[EXPERIMENTAL] Upsert TransportResource Unavailability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/TransportResourceUnavailability","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Unavailability updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"schemaId":"components/schemas/TransportResourceUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Unavailability updated.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransportResourceUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}"},{"label":"[EXPERIMENTAL] Delete TransportResource Unavailability by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource-unavailability/deletetransportresourceunavailability","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability/deletetransportresourceunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete TransportResource Unavailability by id","description":"[EXPERIMENTAL] Delete TransportResource Unavailability by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTransportResourceUnavailability","name":"[EXPERIMENTAL] Delete TransportResource Unavailability by id","isWebhook":false,"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete TransportResource Unavailability by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transport_resource_id","in":"path","schemaId":"schema_2","description":"A unique identifier of a TransportResource. Should only contain characters which do not need URL encoding.","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"transport_resource_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","href":"transport-resource-unavailability/deletetransportresourceunavailability","openApiOperationId":"deleteTransportResourceUnavailability","summary":"[EXPERIMENTAL] Delete TransportResource Unavailability by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Unavailability deleted"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}"},{"label":"[EXPERIMENTAL] Get TransportResource Unavailability by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/transport-resource-unavailability/gettransportresourceunavailability","routeSlug":"/apis/resource-management/resources-api/transport-resource-unavailability/gettransportresourceunavailability","metadata":{"seo":{"title":"[EXPERIMENTAL] Get TransportResource Unavailability by id","description":"[EXPERIMENTAL] Get TransportResource Unavailability by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransportResourceUnavailability","name":"[EXPERIMENTAL] Get TransportResource Unavailability by id","isWebhook":false,"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get TransportResource Unavailability by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transport_resource_id","in":"path","schemaId":"schema_2","description":"A unique identifier of a TransportResource. Should only contain characters which do not need URL encoding.","required":true},{"name":"unavailability_id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided identifier of the Unavailability, or the generated identifier in case of an Unavailability created through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"transport_resource_id","in":"path","required":true,"schemaId":"schema_2"},{"name":"unavailability_id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","href":"transport-resource-unavailability/gettransportresourceunavailability","openApiOperationId":"getTransportResourceUnavailability","summary":"[EXPERIMENTAL] Get TransportResource Unavailability by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transport Resource Unavailability is retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}},"schemaId":"components/schemas/TransportResourceUnavailability","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1transport-resource~1{transport_resource_id}~1unavailability~1{unavailability_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransportResourceUnavailability","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransportResourceUnavailability"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}"}],"content":{"contentType":"group","meta":{"name":"transport-resource-unavailability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unavailability [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define a specific time range during which a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unavailable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be due to, for example, technical issues."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During its duration, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can not be matched with an available "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and used as part of the planning."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transport-resource/{id}/unavailability","summary":"[EXPERIMENTAL] Create TransportResource Unavailability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transport-resource-unavailability/addtransportresourceunavailability","deprecated":false},{"title":"/transport-resource/{id}/unavailability","summary":"[EXPERIMENTAL] Get all TransportResource Unavailabilities by TransportResource id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-resource-unavailability/gettransportresourceunavailabilities","deprecated":false},{"title":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Upsert TransportResource Unavailability","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transport-resource-unavailability/upserttransportresourceunavailability","deprecated":false},{"title":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Delete TransportResource Unavailability by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transport-resource-unavailability/deletetransportresourceunavailability","deprecated":false},{"title":"/transport-resource/{transport_resource_id}/unavailability/{unavailability_id}","summary":"[EXPERIMENTAL] Get TransportResource Unavailability by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transport-resource-unavailability/gettransportresourceunavailability","deprecated":false}]}]}]}]}},{"type":"separator","label":"Location Management","content":null},{"type":"group","label":"Home Base [EXPERIMENTAL]","link":"/apis/resource-management/resources-api/homebase","routeSlug":"/apis/resource-management/resources-api/homebase","items":[{"label":"Get cursor-based home bases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/homebase/getpagedhomebases","routeSlug":"/apis/resource-management/resources-api/homebase/getpagedhomebases","metadata":{"seo":{"title":"Get cursor-based home bases","description":"Retrieve home bases in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedHomeBases","name":"Get cursor-based home bases","isWebhook":false,"pointer":"/paths/~1home-base/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cursor-based home bases","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve home bases in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_0","description":"The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.\n"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Number of results to return per page.\n"}],"pointer":"/paths/~1home-base/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/home-base","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/home-base","href":"homebase/getpagedhomebases","openApiOperationId":"getPagedHomeBases","summary":"Get cursor-based home bases"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The results for the current paged request and optional pointers to related result pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedHomeBases"}},"schemaId":"components/schemas/CursorPagedHomeBases"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1home-base/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagedHomeBases","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedHomeBases"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/home-base"},{"label":"[EXPERIMENTAL] Upsert Home Base","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/homebase/upserthomebase","routeSlug":"/apis/resource-management/resources-api/homebase/upserthomebase","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert Home Base","description":"Upsert a single HomeBase. Once it is created Employees and Transport Resources can make use of it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertHomeBase","name":"[EXPERIMENTAL] Upsert Home Base","isWebhook":false,"pointer":"/paths/~1home-base~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert Home Base","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":"Upsert a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once it is created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transport Resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can make use of it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1home-base~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1home-base~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HomeBase"}},"schemaId":"components/schemas/HomeBase","pointer":"/paths/~1home-base~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/home-base/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HomeBase"}},"responseCodes":["201","204","400","401","412"],"pointer":"/home-base/{id}","href":"homebase/upserthomebase","openApiOperationId":"upsertHomeBase","summary":"[EXPERIMENTAL] Upsert Home Base"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/HomeBase","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HomeBase"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"HomeBase created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HomeBase"}},"schemaId":"components/schemas/HomeBase","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"204","description":"HomeBase created or updated","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1home-base~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/HomeBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HomeBase"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/home-base/{id}"},{"label":"[EXPERIMENTAL] Get Home Base by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/homebase/gethomebase","routeSlug":"/apis/resource-management/resources-api/homebase/gethomebase","metadata":{"seo":{"title":"[EXPERIMENTAL] Get Home Base by id","description":"Get a single HomeBase."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getHomeBase","name":"[EXPERIMENTAL] Get Home Base by id","isWebhook":false,"pointer":"/paths/~1home-base~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get Home Base by id","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":"Get a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1home-base~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/home-base/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/home-base/{id}","href":"homebase/gethomebase","openApiOperationId":"getHomeBase","summary":"[EXPERIMENTAL] Get Home Base by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"HomeBase retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HomeBase"}},"schemaId":"components/schemas/HomeBase","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1home-base~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HomeBase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HomeBase"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/home-base/{id}"},{"label":"[EXPERIMENTAL] Delete Home Base by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/homebase/deletehomebase","routeSlug":"/apis/resource-management/resources-api/homebase/deletehomebase","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete Home Base by id","description":"Delete a single HomeBase."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteHomeBase","name":"[EXPERIMENTAL] Delete Home Base by id","isWebhook":false,"pointer":"/paths/~1home-base~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete Home Base by id","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":"Delete a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only be deleted when there are no resources left referring to it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.","required":true}],"pointer":"/paths/~1home-base~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1home-base~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/home-base/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","409","412"],"pointer":"/home-base/{id}","href":"homebase/deletehomebase","openApiOperationId":"deleteHomeBase","summary":"[EXPERIMENTAL] Delete Home Base by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"HomeBase deleted"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1home-base~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"409","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/home-base/{id}"}],"content":{"contentType":"group","meta":{"name":"homebase"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Home Base [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home Base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a reusable address that is used to specify the location of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transport Resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of specifying a full address for each of these, the user can create a single reusable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and assign it to all."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates to an assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are propagated to all future resources using it."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/home-base","summary":"Get cursor-based home bases","prefix":{"name":"get","color":"get"},"badges":[],"link":"/homebase/getpagedhomebases","deprecated":false},{"title":"/home-base/{id}","summary":"[EXPERIMENTAL] Upsert Home Base","prefix":{"name":"put","color":"put"},"badges":[],"link":"/homebase/upserthomebase","deprecated":false},{"title":"/home-base/{id}","summary":"[EXPERIMENTAL] Get Home Base by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/homebase/gethomebase","deprecated":false},{"title":"/home-base/{id}","summary":"[EXPERIMENTAL] Delete Home Base by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/homebase/deletehomebase","deprecated":false}]}]}]}]}},{"type":"separator","label":"Forecasts","content":null},{"type":"group","label":"Forecast [EXPERIMENTAL]","link":"/apis/resource-management/resources-api/forecast","routeSlug":"/apis/resource-management/resources-api/forecast","items":[{"label":"[EXPERIMENTAL] Upsert Forecast","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/forecast/upsertforecast","routeSlug":"/apis/resource-management/resources-api/forecast/upsertforecast","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert Forecast","description":"Upsert a single Forecast"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertForecast","name":"[EXPERIMENTAL] Upsert Forecast","isWebhook":false,"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert Forecast","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":"Upsert a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forecast"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"date","in":"path","schemaId":"schema_9","description":"Date for which to upsert a forecast","required":true,"example":"2023-10-01"},{"name":"location","in":"path","schemaId":"schema_0","description":"Name of the location for which to upsert the forecast","required":true,"example":"Ghent"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Forecast"}},"schemaId":"components/schemas/Forecast","pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/resource-overview/{date}/{location}/forecasts","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"date","in":"path","required":true,"example":"2023-10-01","schemaId":"schema_9"},{"name":"location","in":"path","required":true,"example":"Ghent","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Forecast"}},"responseCodes":["201","204","400","401"],"pointer":"/resource-overview/{date}/{location}/forecasts","href":"forecast/upsertforecast","openApiOperationId":"upsertForecast","summary":"[EXPERIMENTAL] Upsert Forecast"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/Forecast","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Forecast"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Forecast created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forecast"}},"schemaId":"components/schemas/Forecast","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_10"},{"code":"204","description":"Forecast created or updated","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_10"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Forecast","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forecast"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/resource-overview/{date}/{location}/forecasts"},{"label":"[EXPERIMENTAL] Get Forecast","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/forecast/getforecast","routeSlug":"/apis/resource-management/resources-api/forecast/getforecast","metadata":{"seo":{"title":"[EXPERIMENTAL] Get Forecast","description":"Get a single Forecast."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getForecast","name":"[EXPERIMENTAL] Get Forecast","isWebhook":false,"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get Forecast","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":"Get a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forecast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"date","in":"path","schemaId":"schema_9","description":"Date for which to delete the forecast","required":true,"example":"2023-10-01"},{"name":"location","in":"path","schemaId":"schema_0","description":"Name of the location for which to delete the forecast","required":true,"example":"Ghent"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/resource-overview/{date}/{location}/forecasts","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"date","in":"path","required":true,"example":"2023-10-01","schemaId":"schema_9"},{"name":"location","in":"path","required":true,"example":"Ghent","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/resource-overview/{date}/{location}/forecasts","href":"forecast/getforecast","openApiOperationId":"getForecast","summary":"[EXPERIMENTAL] Get Forecast"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Forecast retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forecast"}},"schemaId":"components/schemas/Forecast"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Forecast","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Forecast"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/resource-overview/{date}/{location}/forecasts"},{"label":"[EXPERIMENTAL] Delete Forecast","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/forecast/deleteforecast","routeSlug":"/apis/resource-management/resources-api/forecast/deleteforecast","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete Forecast","description":"Delete a single Forecast."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteForecast","name":"[EXPERIMENTAL] Delete Forecast","isWebhook":false,"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete Forecast","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":"Delete a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forecast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"date","in":"path","schemaId":"schema_9","description":"Date for which to delete the forecast","required":true,"example":"2023-10-01"},{"name":"location","in":"path","schemaId":"schema_0","description":"Name of the location for which to delete the forecast","required":true,"example":"Ghent"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/resource-overview/{date}/{location}/forecasts","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"date","in":"path","required":true,"example":"2023-10-01","schemaId":"schema_9"},{"name":"location","in":"path","required":true,"example":"Ghent","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401"],"pointer":"/resource-overview/{date}/{location}/forecasts","href":"forecast/deleteforecast","openApiOperationId":"deleteForecast","summary":"[EXPERIMENTAL] Delete Forecast"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Forecast deleted"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1resource-overview~1{date}~1{location}~1forecasts/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/resource-overview/{date}/{location}/forecasts"}],"content":{"contentType":"group","meta":{"name":"forecast"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forecast [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":"A forecast is the expected the number of shifts that will be required on the given day and location.\nThey is used in the context of capacity planning: a difference in the forecast and the available shifts can indicate ue in the planning.\nThe provided forecasts are only used to show to the end user and are not taken into account for any of the calculations made by the application."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/resource-overview/{date}/{location}/forecasts","summary":"[EXPERIMENTAL] Upsert Forecast","prefix":{"name":"put","color":"put"},"badges":[],"link":"/forecast/upsertforecast","deprecated":false},{"title":"/resource-overview/{date}/{location}/forecasts","summary":"[EXPERIMENTAL] Get Forecast","prefix":{"name":"get","color":"get"},"badges":[],"link":"/forecast/getforecast","deprecated":false},{"title":"/resource-overview/{date}/{location}/forecasts","summary":"[EXPERIMENTAL] Delete Forecast","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/forecast/deleteforecast","deprecated":false}]}]}]}]}},{"type":"separator","label":"Deployments","content":null},{"type":"group","label":"Deployment [EXPERIMENTAL]","link":"/apis/resource-management/resources-api/deployment","routeSlug":"/apis/resource-management/resources-api/deployment","items":[{"label":"[EXPERIMENTAL] Get cursor-based deployments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/deployment/getpageddeployments","routeSlug":"/apis/resource-management/resources-api/deployment/getpageddeployments","metadata":{"seo":{"title":"[EXPERIMENTAL] Get cursor-based deployments","description":"Retrieve deployments in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).Deployments without a planning_id are externally managed Deployments.Deployments with a planning_id are managed by releasing or unreleasing routes in PTV OptiFlow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedDeployments","name":"[EXPERIMENTAL] Get cursor-based deployments","isWebhook":false,"pointer":"/paths/~1deployment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get cursor-based deployments","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":"Retrieve deployments in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planning_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are externally managed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planning_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are managed by releasing or unreleasing routes in PTV OptiFlow."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_0","description":"The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.\n"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Number of results to return per page.\n"}],"pointer":"/paths/~1deployment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/deployment","href":"deployment/getpageddeployments","openApiOperationId":"getPagedDeployments","summary":"[EXPERIMENTAL] Get cursor-based deployments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The results for the current paged request and optional pointers to related result pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedDeployments"}},"schemaId":"components/schemas/CursorPagedDeployments"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1deployment/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagedDeployments","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedDeployments"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/deployment"},{"label":"[EXPERIMENTAL] Get Deployment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/deployment/getdeployment","routeSlug":"/apis/resource-management/resources-api/deployment/getdeployment","metadata":{"seo":{"title":"[EXPERIMENTAL] Get Deployment","description":"Get an existing Deployment, defined by their id. Deployments without a planning_id are externally managed Deployments.Deployments with a planning_id are managed by releasing or unreleasing routes in PTV OptiFlow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeployment","name":"[EXPERIMENTAL] Get Deployment","isWebhook":false,"pointer":"/paths/~1deployment~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get Deployment","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":"Get an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", defined by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planning_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are externally managed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planning_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are managed by releasing or unreleasing routes in PTV OptiFlow."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID used to identify this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1deployment~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deployment/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/deployment/{id}","href":"deployment/getdeployment","openApiOperationId":"getDeployment","summary":"[EXPERIMENTAL] Get Deployment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successfully retrieved. Details are in the response body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deployment"}},"schemaId":"components/schemas/Deployment","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1deployment~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Deployment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deployment"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/deployment/{id}"},{"label":"[EXPERIMENTAL] Upsert External Deployment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/deployment/upsertexternaldeployment","routeSlug":"/apis/resource-management/resources-api/deployment/upsertexternaldeployment","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert External Deployment","description":"Create or update an external Deployment. A unique ID is required to identify the Deployment. Calling this endpoint with an existing id will update the `Deployment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertExternalDeployment","name":"[EXPERIMENTAL] Upsert External Deployment","isWebhook":false,"pointer":"/paths/~1deployment~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert External Deployment","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":"Create or update an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A unique ID is required to identify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calling this endpoint with an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will update the `Deployment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represent work assignments that are managed outside of the Resource Management system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We don't allow overlap between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transport Resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can optionally be provided as a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak ETag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"If-Match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. This allows the caller to ensure that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been modified since the last time it was retrieved."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should only contain characters which do not need URL encoding."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1deployment~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1deployment~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalDeployment"}},"schemaId":"components/schemas/ExternalDeployment","pointer":"/paths/~1deployment~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/deployment/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalDeployment"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/deployment/{id}","href":"deployment/upsertexternaldeployment","openApiOperationId":"upsertExternalDeployment","summary":"[EXPERIMENTAL] Upsert External Deployment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/ExternalDeployment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalDeployment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"External Deployment created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deployment"}},"schemaId":"components/schemas/Deployment","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"204","description":"External Deployment created or updated","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1deployment~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Deployment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deployment"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/deployment/{id}"},{"label":"[EXPERIMENTAL] Delete External Deployment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/deployment/deleteexternaldeployment","routeSlug":"/apis/resource-management/resources-api/deployment/deleteexternaldeployment","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete External Deployment","description":"Delete an external Deployment, defined by their id. It is not possible to delete Deployments that are managed by the PTV OptiFlow platform.In order to remove these Deployments, you can use the planning_id to unrelease the corresponding route in the PTV OptiFlow planning."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExternalDeployment","name":"[EXPERIMENTAL] Delete External Deployment","isWebhook":false,"pointer":"/paths/~1deployment~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete External Deployment","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":"Delete an external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", defined by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is not possible to delete "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that are managed by the PTV OptiFlow platform."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to remove these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planning_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unrelease the corresponding route in the PTV OptiFlow planning."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can optionally be provided as a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weak ETag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"If-Match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. This allows the caller to ensure that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been modified since the last time it was retrieved."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this external "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1deployment~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1deployment~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/deployment/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","404","412"],"pointer":"/deployment/{id}","href":"deployment/deleteexternaldeployment","openApiOperationId":"deleteExternalDeployment","summary":"[EXPERIMENTAL] Delete External Deployment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deletion has succeeded and body is empty.\n"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1deployment~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/deployment/{id}"}],"content":{"contentType":"group","meta":{"name":"deployment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deployment [EXPERIMENTAL]","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints used for managing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the actual assignment of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to one or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a specific time period and location. External deployments can be created to represent work assignments that are managed outside of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Management system. Releasing or unreleasing routes in PTV OptiFlow also manages "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deployments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are managed internally by Resource Management and cannot be modified by this API."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/deployment","summary":"[EXPERIMENTAL] Get cursor-based deployments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deployment/getpageddeployments","deprecated":false},{"title":"/deployment/{id}","summary":"[EXPERIMENTAL] Get Deployment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deployment/getdeployment","deprecated":false},{"title":"/deployment/{id}","summary":"[EXPERIMENTAL] Upsert External Deployment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/deployment/upsertexternaldeployment","deprecated":false},{"title":"/deployment/{id}","summary":"[EXPERIMENTAL] Delete External Deployment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/deployment/deleteexternaldeployment","deprecated":false}]}]}]}]}},{"type":"separator","label":"Means","content":null},{"type":"group","label":"Actual","link":"/apis/resource-management/resources-api/actual","routeSlug":"/apis/resource-management/resources-api/actual","items":[{"label":"Get cursor-based actuals for an employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/actual/getpagedemployeeactuals","routeSlug":"/apis/resource-management/resources-api/actual/getpagedemployeeactuals","metadata":{"seo":{"title":"Get cursor-based actuals for an employee","description":"Retrieve actuals for an employee in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPagedEmployeeActuals","name":"Get cursor-based actuals for an employee","isWebhook":false,"pointer":"/paths/~1means~1{employee_id}~1actual/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cursor-based actuals for an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve actuals for an employee in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the employee that the actuals applies to"},"children":[]}]}]}],"required":true,"example":"my-employee-id"}],"pointer":"/paths/~1means~1{employee_id}~1actual/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_0","description":"The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.\n"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Number of results to return per page.\n"}],"pointer":"/paths/~1means~1{employee_id}~1actual/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/means/{employee_id}/actual","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"example":"my-employee-id","schemaId":"schema_0"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/means/{employee_id}/actual","href":"actual/getpagedemployeeactuals","openApiOperationId":"getPagedEmployeeActuals","summary":"Get cursor-based actuals for an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The results for the current paged request and optional pointers to related result pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedEmployeeActuals"}},"schemaId":"components/schemas/CursorPagedEmployeeActuals"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1means~1{employee_id}~1actual/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagedEmployeeActuals","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagedEmployeeActuals"}}},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/means/{employee_id}/actual"},{"label":"[EXPERIMENTAL] Upsert Actual","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/actual/upsertactual","routeSlug":"/apis/resource-management/resources-api/actual/upsertactual","metadata":{"seo":{"title":"[EXPERIMENTAL] Upsert Actual","description":"Upsert a single Actual for an Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertActual","name":"[EXPERIMENTAL] Upsert Actual","isWebhook":false,"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Upsert Actual","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":"Upsert a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the employee that the Actual applies to"},"children":[]}]}]}],"required":true,"example":"my-employee-id"},{"name":"id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should only contain characters which do not need URL encoding."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Prefer","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RFC7240 Prefer header indicates that a particular server behavior"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is preferred by the client but is not required for successful completion"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the request (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://tools.ietf.org/html/rfc7240"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7240"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following behavior (see "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is supported by this API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","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":"return=<minimal|representation>"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to suggest the server to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return using 204 without resource (minimal) or using 200 or 201 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource (representation) in the response body on success."},"children":[]}]}]}]}],"examples":{"minimal":{"description":"Indicate no response is needed, can be omitted","value":"[\"return=minimal\"]"},"representation":{"description":"Request the result of the operation as response","value":"[\"return=representation\"]"}}},{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}},"schemaId":"components/schemas/EmployeeActual","pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/means/{employee_id}/actual/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"example":"my-employee-id","schemaId":"schema_0"},{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"Prefer","in":"header","example":["return=minimal"],"schemaId":"schema_3"},{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}},"responseCodes":["201","204","400","401","404","412"],"pointer":"/means/{employee_id}/actual/{id}","href":"actual/upsertactual","openApiOperationId":"upsertActual","summary":"[EXPERIMENTAL] Upsert Actual"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"schemaId":"components/schemas/EmployeeActual","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Actual created or updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}},"schemaId":"components/schemas/EmployeeActual","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"204","description":"Actual created or updated","headers":{"Preference-Applied":{"$ref":"#/components/headers/Preference-Applied"},"Location":{"$ref":"#/components/headers/Location"},"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_5"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmployeeActual","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/means/{employee_id}/actual/{id}"},{"label":"[EXPERIMENTAL] Get Actual by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/actual/getactual","routeSlug":"/apis/resource-management/resources-api/actual/getactual","metadata":{"seo":{"title":"[EXPERIMENTAL] Get Actual by id","description":"Get a single Actual for an Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActual","name":"[EXPERIMENTAL] Get Actual by id","isWebhook":false,"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Get Actual by id","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":"Get a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the employee that the Actual applies to"},"children":[]}]}]}],"required":true,"example":"my-employee-id"},{"name":"id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should only contain characters which do not need URL encoding."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/means/{employee_id}/actual/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"example":"my-employee-id","schemaId":"schema_0"},{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/means/{employee_id}/actual/{id}","href":"actual/getactual","openApiOperationId":"getActual","summary":"[EXPERIMENTAL] Get Actual by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Actual retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}},"schemaId":"components/schemas/EmployeeActual","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_6"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmployeeActual","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeActual"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/means/{employee_id}/actual/{id}"},{"label":"[EXPERIMENTAL] Delete Actual by id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/resource-management/resources-api/actual/deleteactual","routeSlug":"/apis/resource-management/resources-api/actual/deleteactual","metadata":{"seo":{"title":"[EXPERIMENTAL] Delete Actual by id","description":"Delete a single Actual for an Employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteActual","name":"[EXPERIMENTAL] Delete Actual by id","isWebhook":false,"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Delete Actual by id","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":"Delete a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"employee_id","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the employee that the Actual applies to"},"children":[]}]}]}],"required":true,"example":"my-employee-id"},{"name":"id","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should only contain characters which do not need URL encoding."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_4","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/means/{employee_id}/actual/{id}","servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"parameters":{"path":[{"name":"employee_id","in":"path","required":true,"example":"my-employee-id","schemaId":"schema_0"},{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","400","401","404","412"],"pointer":"/means/{employee_id}/actual/{id}","href":"actual/deleteactual","openApiOperationId":"deleteActual","summary":"[EXPERIMENTAL] Delete Actual by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/resource-management/resources-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Actual deleted"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}},"schemaId":"components/schemas/ProblemWithViolations"},{"code":"401","description":"Authentication required"},{"code":"404","description":"Not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"412","description":"This status is returned when an entity is updated with an outdated version in the If-Match header.\n","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1means~1{employee_id}~1actual~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ProblemWithViolations","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemWithViolations"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/means/{employee_id}/actual/{id}"}],"content":{"contentType":"group","meta":{"name":"actual"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Actual","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actuals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" capture the worked hours for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during a completed work shift. This data is used to provide insights into actual worked hours compared"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to contractual hours, and also helps steer the optimization algorithm towards creating a balanced work week that fulfills contractual hours without significant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"undershooting or overshooting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By their nature, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actuals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should always represent completed work shifts and therefore should always be in the past, adding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actuals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that end in the future could lead to undesired behaviour."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/means/{employee_id}/actual","summary":"Get cursor-based actuals for an employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actual/getpagedemployeeactuals","deprecated":false},{"title":"/means/{employee_id}/actual/{id}","summary":"[EXPERIMENTAL] Upsert Actual","prefix":{"name":"put","color":"put"},"badges":[],"link":"/actual/upsertactual","deprecated":false},{"title":"/means/{employee_id}/actual/{id}","summary":"[EXPERIMENTAL] Get Actual by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actual/getactual","deprecated":false},{"title":"/means/{employee_id}/actual/{id}","summary":"[EXPERIMENTAL] Delete Actual by id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/actual/deleteactual","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CursorPagedEmployees":{"id":"components/schemas/CursorPagedEmployees","kind":"json-schema","title":"CursorPagedEmployees","data":{"type":"object","properties":{"data":{"type":"array","description":"The set of results for the current page.\n","items":{"allOf":[{"$ref":"#/components/schemas/Employee"},{"type":"object","properties":{"etag":{"type":"string","example":"W/\"25\""}}}]}},"cursors":{"$ref":"#/components/schemas/Cursors"}}}},"components/schemas/Cursors":{"id":"components/schemas/Cursors","kind":"json-schema","title":"Cursors","data":{"type":"object","description":"The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information\non these pointers, view the Developer Portal.\n","properties":{"previous":{"type":"string","description":"Pointer to the previous page of results."},"self":{"type":"string","description":"Pointer to the current page of results. When changing the limit in subsequent requests, the first 'limit' results will be contained in the page."},"next":{"type":"string","description":"Pointer to the next page of results."}}}},"components/schemas/Employee":{"id":"components/schemas/Employee","kind":"json-schema","title":"Employee","data":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"employee-42","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"employee-42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"name":{"$ref":"#/components/schemas/EmployeeName"},"driver_skills":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only meaningful in relation to a linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". They are skills of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that determine the feasibility of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the resulting capabilities of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a driver skill contains a dash, it will be split into two upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string"},"example":["digital side mirrors","driving license D"]},"skills":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are inherent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" regardless of the vehicle they are operating, such as language skills. They are available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of the linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a skill contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string"},"example":["Dutch","English"]},"start_location":{"$ref":"#/components/schemas/NamedGeoAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start each work shift, unless otherwise specified on more specific entities. When using an ad-hoc"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (name-based match)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. Resolved address information will be read only and be filled out after resolving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]},"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the system. This represents the location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start each work shift, unless otherwise"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified on more specific entities. When located at a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is conceptually the same as using an ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but with centralized address management which automatically propagates changes on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"root entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]},"linked_resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A reference to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") which should be linked to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if possible. The algorithm will try to adhere to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this requirement as much as possible, but this may not be possible in case of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"differing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"conflicting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on another "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with overlapping availabilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unavailability of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"0-ABC-123"},"wont_do":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to control the capabilities of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This property can be used to disable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A use case could be disabling one type of cargo due. Suppose the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unable to handle the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"big bag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cargo type, but you chose to define cargo"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"types as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capabilities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can add "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"big bag"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s won't do."},"children":[]}]}]}],"example":["big bag"]},"cost":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Costs associated with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which will be combined with assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These costs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"help steer the optimization algorithm towards an optimal solution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addition of costs maintains a precision of 4."},"children":[]}]}]}],"$ref":"#/components/schemas/Cost"},"labels":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows you to select subsets of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vehicles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for use in an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optimization by configuring them in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vehicle Filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a label contains a dash, it will be split into two labels upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"example":["Employee-label-A"]},"route_settings":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL] Various properties that will have an impact on the planning of a route in PTV OptiFlow."},"children":[]}]}]}],"properties":{"driving_speed_factor":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL] This is the factor by which the default speed of the resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gets multiplied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A use case could be a learning driver that might drive 10% slower than his/her colleagues. Setting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driving_speed_factor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to 0.90 ensures the optimization algorithm takes this into account."},"children":[]}]}]}],"example":1.25,"exclusiveMinimum":0},"max_stops_per_shift":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL] This will affect the maximum number of stops an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will get planned for in PTV OptiFlow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this property to ensure that drivers don't get assigned too many stops."},"children":[]}]}]}],"example":3,"minimum":1,"maximum":1000000}}},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["id","business_id"]}},"components/schemas/EmployeeName":{"id":"components/schemas/EmployeeName","kind":"json-schema","title":"EmployeeName","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Both properties are nullable to allow for regional differences."},"children":[]}]}]}],"properties":{"first_name":{"type":"string","example":"Jan","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The given name of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"last_name":{"type":"string","example":"Van den Berghe","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The surname of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/EmployeeUnavailability":{"id":"components/schemas/EmployeeUnavailability","kind":"json-schema","title":"EmployeeUnavailability","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"type":"string","example":"f22896d0-ed42-4a14-a935-7a29072bc5ac","readOnly":true},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"from":{"type":"string","format":"date-time","example":"2021-01-01T06:00:00Z"},"to":{"type":"string","format":"date-time","example":"2021-01-10T06:00:00Z"},"description":{"type":"string","example":"holiday"}},"required":["from","to"]}},"components/schemas/EmployeeUnavailabilities":{"id":"components/schemas/EmployeeUnavailabilities","kind":"json-schema","title":"EmployeeUnavailabilities","data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmployeeUnavailability"},{"type":"object","properties":{"version":{"$ref":"#/components/schemas/Version"}}}]}}},"components/schemas/Cost":{"id":"components/schemas/Cost","kind":"json-schema","title":"Cost","data":{"type":"object","properties":{"per_kilometer":{"description":"A cost to be applied per kilometer in the optimization when utilizing this resource.\n","type":"number","format":"double","example":0.9,"default":0,"minimum":0},"per_hour":{"description":"An hourly cost to be applied in the optimization when utilizing this resource.\n","type":"number","format":"double","example":46.8,"default":0,"minimum":0},"fixed":{"description":"The fixed cost to be applied in the optimization when utilizing this resource.\n","type":"number","format":"double","example":213,"default":0,"minimum":0}}}},"components/schemas/Characteristics":{"id":"components/schemas/Characteristics","kind":"json-schema","title":"Characteristics","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical characteristics of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"maximum_allowed_weight":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum allowed weight for this cargo unit."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This cannot be provided for transport resources of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRACTOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","format":"double","example":3500,"minimum":0}}}},"components/schemas/RouteSettings":{"id":"components/schemas/RouteSettings","kind":"json-schema","title":"RouteSettings","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Route settings for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"direct_trips":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricts this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to direct trips during planning."},"children":[]}]}]}],"type":"boolean","example":false}},"required":["direct_trips"]}},"components/schemas/CursorPagedEmployeeActuals":{"id":"components/schemas/CursorPagedEmployeeActuals","kind":"json-schema","title":"CursorPagedEmployeeActuals","data":{"type":"object","properties":{"data":{"type":"array","description":"The set of results for the current page.\n","items":{"allOf":[{"$ref":"#/components/schemas/EmployeeActual"},{"type":"object","properties":{"etag":{"type":"string","example":"W/\"25\""}}}]}},"cursors":{"$ref":"#/components/schemas/Cursors"}}}},"components/schemas/EmployeeActual":{"id":"components/schemas/EmployeeActual","kind":"json-schema","title":"EmployeeActual","data":{"allOf":[{"type":"object","properties":{"employee_id":{"type":"string","example":"hvertenten","readOnly":true}},"required":["employee_id"]},{"$ref":"#/components/schemas/BaseEmployeeActual"}]}},"components/schemas/BaseEmployeeActual":{"id":"components/schemas/BaseEmployeeActual","kind":"json-schema","title":"BaseEmployeeActual","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual work time a certain employee has executed for a particular date and time."},"children":[]}]}]}],"properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"14-05-2025-morning-shift","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"14-05-2025-morning-shift","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"start":{"description":"A date and time when the activity was started.\n","type":"string","format":"date-time","example":"2025-05-14T08:00:00Z"},"end":{"description":"A date and time when the activity has ended.\n","type":"string","format":"date-time","example":"2025-05-14T17:00:00Z"},"work_time":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total work time performed by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be an ISO-8601 compliant Duration string. Must be strictly positive."},"children":[]}]}]}],"type":"string","format":"ISO-8601","example":"PT8H"}},"required":["id","business_id","start","work_time"]}},"components/schemas/Availabilities":{"id":"components/schemas/Availabilities","kind":"json-schema","title":"Availabilities","data":{"type":"array","uniqueItems":true,"items":{"allOf":[{"$ref":"#/components/schemas/Availability"},{"type":"object","properties":{"version":{"$ref":"#/components/schemas/Version"}}}]}}},"components/schemas/Availability":{"id":"components/schemas/Availability","kind":"json-schema","title":"Availability","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that describes the interval in which the employee is available to work. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the basis for creating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (combining the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") but can be altered by the presence of (partially) overlapping "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailabilities"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Relocations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only managed through the user interface)."},"children":[]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"type":"string","readOnly":true,"example":"f22896d0-ed42-4a14-a935-7a29072bc5ac"},"employee_id":{"$ref":"#/components/schemas/EmployeeId"},"start_location":{"$ref":"#/components/schemas/AvailabilityStartLocation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this specific work shift. This overrides the ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or home base on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using an ad-hoc location, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (name-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match), unless that employee is on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Journey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In that case they will continue to use the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Journey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is done."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. Resolved address information will be read-only and be filled out after resolving."},"children":[]}]}]}]},"home_base_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the system. This represents the location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this specific work shift. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overrides the  ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or home base on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".  When located at a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Home"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to Transport"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Resources"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is conceptually the same as using an ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but with centralized address management which automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"propagates changes on the root "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with providing an ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither is mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"type":"string","example":"a-home-base-id","deprecated":true},"end_location":{"$ref":"#/components/schemas/EndLocation"},"earliest_start":{"type":"string","format":"date-time","example":"2021-01-01T04:15:30Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The earliest instant that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can start this work shift."},"children":[]}]}]}]},"latest_start":{"type":"string","format":"date-time","example":"2021-01-01T06:00:00Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest instant that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can start this work shift. If not provided, the optimization will potentially introduce wait time starting from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earliest_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used to execute tasks."},"children":[]}]}]}]},"latest_stop":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest time at which the availability should end. This can be useful for defining schedules with a lenient start window, but where the Employee"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has a hard stop at a certain time. It should be between ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earliest_start + min_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latest_start + max_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latest_stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it will be extrapolated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latest_start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]}]}]}],"type":"string","format":"date-time","example":"2021-01-01T16:00:00Z"},"min_duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimal duration of a shift during the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be an ISO-8601 compliant Duration string. If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the application"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will treat the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_duration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it needs to determine the timeframe in which this shift ends."},"children":[]}]}]}],"type":"string","example":"PT8H"},"max_duration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum duration of a shift during the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be an ISO-8601 compliant Duration string."},"children":[]}]}]}],"type":"string","example":"PT12H"},"mandatory":{"description":"Indicates whether the resulting combination is required to be used when planned","type":"boolean","default":false,"example":true}},"required":["earliest_start","max_duration"]}},"components/schemas/ShiftSchedules":{"id":"components/schemas/ShiftSchedules","kind":"json-schema","title":"ShiftSchedules","data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ShiftSchedule"},{"type":"object","properties":{"version":{"$ref":"#/components/schemas/Version","description":"The version of the shift schedule. Present when the shift schedule is returned in a list in a response."}}}]}}},"components/schemas/ShiftSchedule":{"id":"components/schemas/ShiftSchedule","kind":"json-schema","title":"ShiftSchedule","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Shift Schedule for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID, generated by the application upon creation."},"children":[]}]}]}],"type":"string","example":"f22896d0-ed42-4a14-a935-7a29072bc5ac","readOnly":true},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional name for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"Standard 38H"},"start":{"$ref":"#/components/schemas/ShiftScheduleStart"},"templates":{"type":"array","minLength":1,"description":"List of non-null objects describing one calendar week (MON-SUN) worth of shifts.\n","items":{"$ref":"#/components/schemas/RecurrencePeriod"}}},"required":["templates","start"]}},"components/schemas/EmployeeId":{"id":"components/schemas/EmployeeId","kind":"json-schema","title":"EmployeeId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"employee-42"}},"components/schemas/RecurrencePeriod":{"id":"components/schemas/RecurrencePeriod","kind":"json-schema","title":"RecurrencePeriod","data":{"type":"object","description":"Shifts within one calendar week.\n","properties":{"index":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-based index that determines the order in the schedule. Indices should be consecutive within a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ShiftSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", without gaps. Setting up a schedule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a recurring week off can be achieved by providing an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-array within the corresponding week's template."},"children":[]}]}]}]},"shifts":{"type":"array","description":"List of non-null shifts in this calendar week. The list can remain empty to represent a recurring week off. \n\nShifts should not overlap within one template, but can also not overlap with the adjoining shift of other templates. The last shift within a template \nwill be validated against the first shift of the next template. When this template is the last template of the schedule the application will roll over \nto the first template of the schedule for validating the non-overlapping constraint. This also means a single-week schedule should not have any overlap\nbetween the last and first shift of the schedule.\n","items":{"$ref":"#/components/schemas/Shift"}},"acceptable_additional_work_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The additional time an employee is willing to work, if needed, beyond their contractual hours during the current calendar week."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used to determine whether the employee’s actual work time exceeds what they are willing to work — defined as the sum of their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contractual work time and this additional work time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is provided, contractual_work_time must also be specified for each shift in the calendar week."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a strictly positive ISO 8601-compliant duration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]}]}],"example":"PT4H"}},"required":["index","shifts"]}},"components/schemas/Shift":{"id":"components/schemas/Shift","kind":"json-schema","title":"Shift","data":{"type":"object","properties":{"start":{"type":"object","description":"The start range for this specific shift.\n","properties":{"earliest":{"$ref":"#/components/schemas/TimeInWeek"},"window":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earliest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" start until the latest start, formatted as an ISO-8601 compliant Duration string. If provided, it must be positive."},"children":[]}]}]}],"type":"string","example":"PT3H"}},"required":["earliest"]},"stop":{"type":"object","description":"Optional constraints on when this shift should finish.\n","properties":{"latest":{"$ref":"#/components/schemas/TimeInWeek","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An (optional) latest stop. This can be useful for defining schedules with a lenient start window, but where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a hard stop at a certain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latest stop must be within the (calculated) bounds of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s end. These bounds are defined as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"earliest stop:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration.at_least"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start.earliest + duration.at_least"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not provided: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start.earliest + duration.at_most"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latest stop:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start.earliest + (optional) start.window + duration.at_most"},"children":[]}]}]}]}]}}},"duration":{"type":"object","description":"The limits of the duration of this shift.","properties":{"at_least":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimal duration of a shift. Must be an ISO-8601 compliant Duration string. If provided, it must be strictly positive and greater than or equal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start.window"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"PT8H"},"at_most":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum duration of a shift. Must be an ISO-8601 compliant Duration string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"strictly positive,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start.window"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_least"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lower than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P7D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (7 days)."},"children":[]}]}]}]}],"type":"string","example":"PT12H"}},"required":["at_most"]},"mandatory":{"description":"Indicates whether the resulting combination is required to be used when planned.","default":false,"type":"boolean","example":true},"start_location":{"$ref":"#/components/schemas/ShiftStartLocation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defined on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By specifying this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]},"end_location":{"$ref":"#/components/schemas/EndLocation"},"contractual_work_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The duration an employee is contractually expected to work during this shift."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used to determine whether the employee worked more or less than expected based on their contract."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that only the at_least and at_most durations for the current shift influence the work time that will be planned for this shift."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this field is provided, it must be specified for each shift within the shift schedule."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, acceptable_additional_work_time must be defined for each calender week."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value must be a zero or positive ISO 8601-compliant duration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL]"},"children":[]}]}]}],"example":"PT8H"}},"required":["start","duration"]}},"components/schemas/AvailabilityStartLocation":{"id":"components/schemas/AvailabilityStartLocation","kind":"json-schema","title":"AvailabilityStartLocation","data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/NamedGeoAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this specific work "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This overrides the  ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or home base on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using an ad-hoc location, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (name-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. Resolved address information will be read only and be filled out after resolving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_last_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the system. This represents the location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless otherwise specified on more specific entities. When located at a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is conceptually the same as using an ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but with centralized address management which automatically propagates changes on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"root entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with providing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_last_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"at_last_end":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this is set, the planning will use the end location of the preceding deployed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the starting point for this one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is mutually exclusive with providing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name by which to identify this location. If used as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is used for matching colocated entities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required only when using the deprecated fields."},"children":[]}]}]}],"example":"PTV Logistics","deprecated":true},"address_line":{"type":"string","example":"Voordries 41b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address line of this location's address. Can contain street, house number, bus and more."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"deprecated":true},"city":{"type":"string","example":"Oosterzele","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the locality of this location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"deprecated":true},"zip_code":{"type":"string","example":"9860","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ZIP code of the locality of this location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"deprecated":true},"country_code":{"$ref":"#/components/schemas/CountryCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO3166-1 alpha-2 two letter country code for this location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"deprecated":true},"geo_point":{"$ref":"#/components/schemas/GeoPoint","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated in favor of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}}}},"components/schemas/ShiftStartLocation":{"id":"components/schemas/ShiftStartLocation","kind":"json-schema","title":"ShiftStartLocation","data":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/NamedGeoAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this specific work "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This overrides the  ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or home base on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When using an ad-hoc location, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (name-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. Resolved address information will be read only and be filled out after resolving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with providing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_last_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the system. This represents the location from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will start this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unless otherwise specified on more specific entities. When located at a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only be assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is conceptually the same as using an ad-hoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but with centralized address management which automatically propagates changes on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"root entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with providing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_last_end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"at_last_end":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this is set to true, the planning will use the end location of the preceding deployed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the starting point for this shift."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is mutually exclusive with providing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but neither are mandatory for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/ShiftScheduleStart":{"id":"components/schemas/ShiftScheduleStart","kind":"json-schema","title":"ShiftScheduleStart","data":{"type":"object","description":"The start date and start week number of this shift schedule","properties":{"start_date":{"type":"string","format":"date","description":"The calendar day at which this schedule starts.","example":"2014-08-16"},"start_week":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The one-based index of the template at which this schedule starts. This allows you to offset the week from which the application start extrapolating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the potential availability of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This can be useful for instances where an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a multi-week schedule but you want the even and uneven weeks to line up with the weeks of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"year."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index should always be within the bounds of the schedule's template indices."},"children":[]}]}]}],"minimum":1,"example":1}},"required":["start_date","start_week"]}},"components/schemas/TimeInWeek":{"id":"components/schemas/TimeInWeek","kind":"json-schema","title":"TimeInWeek","data":{"description":"Specifies a time on a specified day of the week.\n","type":"object","properties":{"time":{"$ref":"#/components/schemas/Time"},"day":{"$ref":"#/components/schemas/DayOfWeek"}},"required":["time","day"]}},"components/schemas/Time":{"id":"components/schemas/Time","kind":"json-schema","title":"Time","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a time, formatted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hh:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supports 00:00-23:59 inclusive."},"children":[]}]}]}],"type":"string","pattern":"^([0-1][0-9]|[2][0-3]):([0-5][0-9])$","example":"14:45"}},"components/schemas/DayOfWeek":{"id":"components/schemas/DayOfWeek","kind":"json-schema","title":"DayOfWeek","data":{"type":"string","example":"MONDAY","description":"Specifies a day of the week, must match the exhaustive set of values.\n","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"components/schemas/CustomData":{"id":"components/schemas/CustomData","kind":"json-schema","title":"CustomData","data":{"title":"CustomData","description":"Custom data is an extendable hashmap of key-value pairs for client usage. These values have no meaning in the context of Resource Management, but can be used to \nenrich the data in OptiFlow with relevant information for the end users.    \n\nKeys should not be blank nor contain periods.\n","additionalProperties":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single key-value pair, with the value being an optional string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The platform distinguishes between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (there is no value for this key) and empty values (the value of this key is an empty string: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When setting the value of a custom data property to an empty string, the key will still be present on a vehicle in an OptiFlow Match planning (for relevant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entities), whereas setting the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" signifies that this key is not a part of this entity."},"children":[]}]}]}]},"example":{"shop_manager":"John Smith"}}},"components/schemas/GeoPoint":{"id":"components/schemas/GeoPoint","kind":"json-schema","title":"GeoPoint","data":{"properties":{"latitude":{"type":"number","format":"double","example":50.9514048},"longitude":{"type":"number","format":"double","example":3.8067878},"resolved":{"readOnly":true,"type":"object","description":"Indicates whether the address is resolved.","properties":{"geocoded":{"type":"boolean","example":true},"address":{"type":"string","example":"Voordries 31 bus B, 9860 Oosterzele"},"precision":{"type":"integer","example":9}}}},"required":["latitude","longitude"]}},"components/schemas/GeoAddress":{"id":"components/schemas/GeoAddress","kind":"json-schema","title":"GeoAddress","data":{"type":"object","description":"Either address information should be present, or otherwise the geo point. The resolved information will be read only and be filled out after resolving.","properties":{"address_line":{"type":"string","example":"Voordries 41b","description":"The address line of this location's address. Can contain street, house number, bus and more.\n"},"city":{"type":"string","example":"Oosterzele","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the locality of this location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"zip_code":{"type":"string","example":"9860","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ZIP code of the locality of this location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"country_code":{"$ref":"#/components/schemas/CountryCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ISO3166-1 alpha-2 two letter country code for this location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"geo_point":{"$ref":"#/components/schemas/GeoPoint"}}}},"components/schemas/EndLocation":{"id":"components/schemas/EndLocation","kind":"json-schema","title":"EndLocation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[EXPERIMENTAL] Property to define an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When left blank, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will make a round-trip and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one option is allowed, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_last_activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be set."},"children":[]}]}]}],"properties":{"address":{"$ref":"#/components/schemas/NamedGeoAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ad-hoc address where this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will end during this specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. Resolved address information will be read-only and be filled out after resolving."},"children":[]}]}]}]},"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a know "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will end during this specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Availability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"at_last_activity":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optimization will determine the best (eg: most cost-effective) location. This location will always be an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s location. This option can only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be honored for plannings that do a PickupDelivery optimization. When set for other types of plannings, the optimization will result in a round trip."},"children":[]}]}]}]}}}},"components/schemas/NamedGeoAddress":{"id":"components/schemas/NamedGeoAddress","kind":"json-schema","title":"NamedGeoAddress","data":{"type":"object","description":"Either textual address information or geo point must be provided. The resolved information will be read only and be filled out after resolving.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name by which to identify this location. If used as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is used for matching colocated entities."},"children":[]}]}]}],"example":"PTV Logistics"}}},{"$ref":"#/components/schemas/GeoAddress"}],"required":["name"]}},"components/schemas/LinkedHomeBase":{"id":"components/schemas/LinkedHomeBase","kind":"json-schema","title":"LinkedHomeBase","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conceptually the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but with centralized address management."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}],"properties":{"business_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"depot-1","deprecated":true},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"depot-1"}},"required":["id","business_id"]}},"components/schemas/Capacity":{"id":"components/schemas/Capacity","kind":"json-schema","title":"Capacity","data":{"title":"Capacity","type":"object","description":"Dimensional value of a capacity.\n","properties":{"type":{"type":"string","enum":["volume","weight","loadingMeters","capacity1","capacity2","capacity3","capacity4","capacity5"],"description":"characterization of a capacity, default volume","default":"volume"},"value":{"type":"number","format":"double","example":20.02}},"required":["value"]}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"description":"represents the ISO3166-1 alpha-2 two letter country codes","type":"string","pattern":"^[A-Z]{2}$","example":"BE"}},"components/schemas/Forecast":{"id":"components/schemas/Forecast","kind":"json-schema","title":"Forecast","data":{"description":"The expected number of shifts for a given date and location","type":"object","properties":{"expected_shifts":{"type":"integer","minimum":0,"description":"Expected number of shifts","example":27},"location":{"readOnly":true,"type":"string","description":"Name of the location","example":"Ghent"},"date":{"readOnly":true,"description":"Date of the forecast","type":"string","format":"date","example":"2023-10-01"}}}},"components/schemas/CursorPagedHomeBases":{"id":"components/schemas/CursorPagedHomeBases","kind":"json-schema","title":"CursorPagedHomeBases","data":{"type":"object","properties":{"data":{"type":"array","description":"The set of results for the current page.\n","items":{"allOf":[{"$ref":"#/components/schemas/HomeBase"},{"type":"object","properties":{"etag":{"type":"string","example":"W/\"25\""}}}]}},"cursors":{"$ref":"#/components/schemas/Cursors"}}}},"components/schemas/HomeBase":{"id":"components/schemas/HomeBase","kind":"json-schema","title":"HomeBase","data":{"description":"The location where an employee or transport resource is usually found. Combinations will only be made with resources within the same home base.","type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","example":"HB-GHENT-01","readOnly":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","example":"HB-GHENT-01","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"name":{"type":"string","description":"Name of the home base","example":"Ghent - Headquarters"},"address":{"$ref":"#/components/schemas/GeoAddress"},"plan_group":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the plan group to which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs"},"children":[]}]}]}],"example":"cargo planning"}}}},"components/schemas/CursorPagedTransportResources":{"id":"components/schemas/CursorPagedTransportResources","kind":"json-schema","title":"CursorPagedTransportResources","data":{"type":"object","properties":{"data":{"type":"array","description":"The set of results for the current page.\n","items":{"allOf":[{"$ref":"#/components/schemas/TransportResource"},{"type":"object","properties":{"etag":{"type":"string","example":"W/\"25\""}}}]}},"cursors":{"$ref":"#/components/schemas/Cursors"}}}},"components/schemas/TransportResource":{"id":"components/schemas/TransportResource","kind":"json-schema","title":"TransportResource","data":{"type":"object","properties":{"business_id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"tractor-1","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deprecated in favor of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"tractor-1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"$ref":"#/components/schemas/ResourceType"},"license_plate":{"type":"string","example":"1-ABC-987"},"requirements":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of requirements the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must fulfill to be allowed to use this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","example":"driving license CE"}},"capabilities":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capabilities this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","example":"big bag"}},"required_capabilities":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of requirements the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must fulfill, which will be provided as capabilities to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a required capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","example":"cooling compressor"}},"skilled_capabilities":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of capabilities which will be provided to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"driver_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a skilled capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"items":{"type":"string","example":"sideloading"}},"cant_do":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of capabilities which will be disabled on the resulting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: A TRACTOR with a faulty electric plug, can not be used with a TRAILER that exposes a capability which requires this plug."},"children":[]}]}]}],"items":{"type":"string","example":"adr-transport"}},"capacities":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These capacities mirror the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order Book"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" capacities."},"children":[]}]}]}],"minItems":1,"maxItems":8,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Capacity"}},"linked_resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of another "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the same location that should be coupled with this one no matter what."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is known as a fixed coupling."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By using this you can indicate that a tractor should always be coupled with a specific trailer (or the other way around)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no need to specify the linking in both directions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This overwrites all requirements and as such could lead to seemingly invalid situations, but this is at the discretion of the planner."},"children":[]}]}]}],"example":"trailer-1"},"start_location":{"$ref":"#/components/schemas/NamedGeoAddress","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either address information or geo point must be provided. The resolved information will be read only and be filled out after resolving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]},"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conceptually the same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but with centralized address management."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]},"reference":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional, internal reference (eg: fleet number, ...) for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","example":"fleet-reference-47"},"custom_data":{"$ref":"#/components/schemas/CustomData"},"labels":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Combination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: if a label contains a dash, it will be split into two labels upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization."},"children":[]}]}]}],"example":["Transport-resource-label-A"]},"inactive":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag to indicate whether a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for creating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all future "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceCombinations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be removed."},"children":[]}]}]}]},"cost":{"$ref":"#/components/schemas/Cost"},"characteristics":{"$ref":"#/components/schemas/Characteristics"},"route_settings":{"$ref":"#/components/schemas/RouteSettings"}},"required":["id","business_id","type"]}},"components/schemas/TransportResourceId":{"id":"components/schemas/TransportResourceId","kind":"json-schema","title":"TransportResourceId","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^[a-zA-Z0-9.~\\-_]+$","readOnly":true,"example":"tractor-1"}},"components/schemas/TransportResourceUnavailabilities":{"id":"components/schemas/TransportResourceUnavailabilities","kind":"json-schema","title":"TransportResourceUnavailabilities","data":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/TransportResourceUnavailability"},{"type":"object","properties":{"version":{"$ref":"#/components/schemas/Version"}}}]}}},"components/schemas/TransportResourceUnavailability":{"id":"components/schemas/TransportResourceUnavailability","kind":"json-schema","title":"TransportResourceUnavailability","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"type":"string","readOnly":true},"transport_resource_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TransportResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that has this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unavailability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/TransportResourceId"},"from":{"type":"string","format":"date-time","example":"2021-01-01T06:00:00Z"},"to":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be strictly greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]}]}]}],"type":"string","format":"date-time","example":"2021-01-10T06:00:00Z"},"description":{"type":"string","example":"maintenance"}},"required":["from","to"]}},"components/schemas/ResourceType":{"id":"components/schemas/ResourceType","kind":"json-schema","title":"ResourceType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRACTOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a pulling  unit, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRAILER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a cargo unit and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRUCK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is both a pulling and cargo unit."},"children":[]}]}]}],"type":"string","example":"TRACTOR","enum":["TRACTOR","TRAILER","TRUCK"]}},"components/schemas/Version":{"id":"components/schemas/Version","kind":"json-schema","title":"Version","data":{"type":"integer","description":"Version of the entity, can be used for optimistic locking.","example":42}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","properties":{"title":{"type":"string","example":"Validation exception","description":"A short, summary of the problem."},"detail":{"type":"string","description":"A detailed explanation specific to this problem.","example":"The field contains invalid business formatting."}}}},"components/schemas/ProblemWithViolations":{"id":"components/schemas/ProblemWithViolations","kind":"json-schema","title":"ProblemWithViolations","data":{"allOf":[{"$ref":"#/components/schemas/Problem"},{"type":"object","properties":{"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}}}}]}},"components/schemas/Violation":{"id":"components/schemas/Violation","kind":"json-schema","title":"Violation","data":{"type":"object","properties":{"field":{"type":"string","example":"path.to.field"},"message":{"type":"string","example":"Field is required"}}}},"components/schemas/CursorPagedDeployments":{"id":"components/schemas/CursorPagedDeployments","kind":"json-schema","title":"CursorPagedDeployments","data":{"type":"object","properties":{"data":{"type":"array","description":"The set of results for the current page.\n","items":{"$ref":"#/components/schemas/Deployment"}},"cursors":{"$ref":"#/components/schemas/Cursors"}}}},"components/schemas/Deployment":{"id":"components/schemas/Deployment","kind":"json-schema","title":"Deployment","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique deployment ID.","example":"deployment-123"},"resource_combination_id":{"type":"string","description":"The ID of the associated resource combination, if any.","example":"rc-456"},"availability_id":{"type":"string","description":"The ID of the associated availability, if any.","example":"avail-789"},"employee_id":{"type":"string","description":"The ID of the employee assigned to this deployment.","example":"employee-42"},"transport_resource_ids":{"type":"array","items":{"type":"string"},"description":"The IDs of the transport resources assigned to this deployment.","example":["truck-1","trailer-2"]},"start":{"$ref":"#/components/schemas/DeploymentStart"},"end":{"$ref":"#/components/schemas/DeploymentEnd"},"total_break_time":{"type":"string","description":"Total break time during the deployment, formatted as ISO-8601 duration.","example":"PT1H"},"planning_id":{"type":"string","description":"The ID of the planning that created this deployment, if any.","example":"planning-123"}}}},"components/schemas/DeploymentStart":{"id":"components/schemas/DeploymentStart","kind":"json-schema","title":"DeploymentStart","data":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"When the deployment starts.","example":"2021-01-01T08:00:00Z"},"location":{"$ref":"#/components/schemas/DeploymentLocation"}},"required":["at","location"]}},"components/schemas/DeploymentEnd":{"id":"components/schemas/DeploymentEnd","kind":"json-schema","title":"DeploymentEnd","data":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"When the deployment ends.","example":"2021-01-01T17:00:00Z"},"location":{"$ref":"#/components/schemas/DeploymentLocation"}},"required":["at","location"]}},"components/schemas/DeploymentLocation":{"id":"components/schemas/DeploymentLocation","kind":"json-schema","title":"DeploymentLocation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location for the deployment. For external deployments, either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"home_base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided, but not both."},"children":[]}]}]}],"properties":{"home_base":{"$ref":"#/components/schemas/LinkedHomeBase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a known "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HomeBase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the system for this deployment location."},"children":[]}]}]}]},"address":{"$ref":"#/components/schemas/NamedGeoAddress","description":"Address for this deployment location.\n"}}}},"components/schemas/ExternalDeployment":{"id":"components/schemas/ExternalDeployment","kind":"json-schema","title":"ExternalDeployment","data":{"type":"object","properties":{"employee":{"type":"string","description":"The business ID of the employee for this deployment.","example":"employee-42"},"transport_resources":{"type":"array","items":{"type":"string"},"description":"The business IDs of the transport resources for this deployment.","example":["truck-1","trailer-2"]},"start":{"$ref":"#/components/schemas/DeploymentStart"},"end":{"$ref":"#/components/schemas/DeploymentEnd"},"total_break_time":{"type":"string","description":"Total break time during the deployment, formatted as ISO-8601 duration.","example":"PT1H"}},"required":["employee","transport_resources","start","end","total_break_time"]}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"default":100},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","example":"W/\"24\""},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"ETag":{"type":"string","example":"W/\"25\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A weak Etag (ex "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W/\"<etag_value>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") which contains the current version of the entity"},"children":[]}]}]}]},"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a preference has been applied. (ex "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=representation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"Location":{"type":"string","format":"URI","description":"A URI to access the result of the operation."}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"ETag":{"type":"string","example":"W/\"25\"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A weak Etag (ex "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"W/\"<etag_value>\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") which contains the current version of the entity"},"children":[]}]}]}]}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","properties":{"Preference-Applied":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a preference has been applied. (ex "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return=representation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"Location":{"type":"string","format":"URI","description":"A URI to access the result of the operation."}}},"id":"schema_10"}},"exampleStore":{"paths/~1ping/get/responses/200/content/text~1plain/example":{"value":"pong","id":"paths/~1ping/get/responses/200/content/text~1plain/example"}},"securitySchemeStore":{"clientCredentials":{"id":"clientCredentials","type":"oauth2","description":"This API uses OAuth2 with the Client Credentials flow for M2M communication. Client ID ans secret should be provided as a HTTP Basic Auth header.\n","flows":{"clientCredentials":{"tokenUrl":"https://auth.conundra.eu/auth/realms/prod/protocol/openid-connect/token","scopes":{}}}}},"servers":[{"url":"/_mock/apis/resource-management/resources-api","isMockServer":true,"description":"Mock server"},{"url":"https://api.conundra.eu/resource-management/v1","description":"Resources API Production"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[]},"hidePropertiesPrefix":true,"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"url":"/_mock/apis/resource-management/resources-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/resource-management/resources-api.json?download"},{"url":"/_bundle/apis/resource-management/resources-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"PTV OptiFlow Resources API","description":"The Resources API provides the resources necessary to create a planning.\n"}},"baseSlug":"/apis/resource-management/resources-api","routesMapping":{}}