{"items":[{"type":"link","label":"PTV OptiFlow Planning API","link":"/apis/plannings/planning-api","routeSlug":"/apis/plannings/planning-api","content":{"contentType":"overview","meta":{"name":"PTV OptiFlow Planning API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"planning-api.json","url":"/_bundle/apis/plannings/planning-api.json?download"},{"kind":"download","label":"planning-api.yaml","url":"/_bundle/apis/plannings/planning-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/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"PTV OptiFlow Planning API (v1.23.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The planning API provides information about plannings and their lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/planning/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/apis/plannings/planning-api"}],"sectionId":"/apis/plannings/planning-api"}]}]}},{"type":"separator","label":"Health","content":null},{"type":"group","label":"Health","link":"/apis/plannings/planning-api/health","routeSlug":"/apis/plannings/planning-api/health","items":[{"label":"Returns a single `pong` string","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/health/ping","routeSlug":"/apis/plannings/planning-api/health/ping","metadata":{"seo":{"title":"Returns a single `pong` string","description":"The ping-endpoint can be used for validating a connection with the application.It will authenticate the caller and returns a pong response when everything is set-up correctly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ping","name":"Returns a single `pong` string","isWebhook":false,"pointer":"/paths/~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a single `pong` string","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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will authenticate the caller and returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pong"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response when 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 and 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/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":"Returns a single `pong` string"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Everything set-up correctly","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_65","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"]}},"schemaId":"schema_65","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"]},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1ping/get/responses/200/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_65","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","showPageActions":true},{"nodeType":"markdoc","content":"Validate connection and accessibility of the API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ping","summary":"Returns a single `pong` string","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/ping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Plannings","content":null},{"type":"group","label":"Plannings","link":"/apis/plannings/planning-api/plannings","routeSlug":"/apis/plannings/planning-api/plannings","items":[{"label":"Get a cursor paged list of plannings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plannings/getplannings","routeSlug":"/apis/plannings/planning-api/plannings/getplannings","metadata":{"seo":{"title":"Get a cursor paged list of plannings","description":"Returns a cursor paged list of plannings. Results are sorted by created_at in descending order.You can find out more about how to use cursors in our developer portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlannings","name":"Get a cursor paged list of plannings","isWebhook":false,"pointer":"/paths/~1plannings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a cursor paged list of plannings","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":"Returns a cursor paged list of plannings. Results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in descending order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find out more about how to use cursors in our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.conundra.eu/developer-portal/cursor-paging/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer portal"},"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 and 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":"released_since","in":"query","schemaId":"schema_66","description":"When provided, only plannings which have been released since (exclusive) the given date will be returned.\n"},{"name":"cursor","in":"query","schemaId":"schema_65","description":"Cursor of the page to retrieve."},{"name":"limit","in":"query","schemaId":"schema_67","description":"The maximum amount of plannings that should be returned in the response"}],"pointer":"/paths/~1plannings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plannings","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"released_since","in":"query","example":"2021-01-01T10:15:30Z","schemaId":"schema_66"},{"name":"cursor","in":"query","schemaId":"schema_65"},{"name":"limit","in":"query","example":100,"schemaId":"schema_67"}],"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":"/plannings","href":"plannings/getplannings","openApiOperationId":"getPlannings","summary":"Get a cursor paged list of plannings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPlanningsResponse"}},"schemaId":"components/schemas/GetPlanningsResponse"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1plannings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPlanningsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPlanningsResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/plannings"},{"label":"Retrieve a released planning using a given planning id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plannings/getlatestreleasebyplanningid","routeSlug":"/apis/plannings/planning-api/plannings/getlatestreleasebyplanningid","metadata":{"seo":{"title":"Retrieve a released planning using a given planning id","description":"Retrieves detailed information on the given released planning."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLatestReleaseByPlanningId","name":"Retrieve a released planning using a given planning id","isWebhook":false,"pointer":"/paths/~1plannings~1{id}~1releases~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a released planning using a given planning id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given released planning.\n\nNote that information about releases are only stored for 2 weeks after the release was made. If you try to retrieve a release which is older than 2 weeks, you will get a 404 Not Found response.\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 and 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_65","description":"The unique identifier of a planning","required":true}],"pointer":"/paths/~1plannings~1{id}~1releases~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plannings/{id}/releases/latest","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_65"}],"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":"/plannings/{id}/releases/latest","href":"plannings/getlatestreleasebyplanningid","openApiOperationId":"getLatestReleaseByPlanningId","summary":"Retrieve a released planning using a given planning id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Release"}},"schemaId":"components/schemas/Release"},{"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/~1plannings~1{id}~1releases~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Release","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Release"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/plannings/{id}/releases/latest"}],"content":{"contentType":"group","meta":{"name":"plannings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plannings","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for retrieving information about plannings and its releases."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/plannings","summary":"Get a cursor paged list of plannings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plannings/getplannings","deprecated":false},{"title":"/plannings/{id}/releases/latest","summary":"Retrieve a released planning using a given planning id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plannings/getlatestreleasebyplanningid","deprecated":false}]}]}]}]}},{"type":"separator","label":"Plan profiles","content":null},{"type":"group","label":"Plan Profiles","link":"/apis/plannings/planning-api/plan-profiles","routeSlug":"/apis/plannings/planning-api/plan-profiles","items":[{"label":"List the existing plan profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plan-profiles/listplanprofiles","routeSlug":"/apis/plannings/planning-api/plan-profiles/listplanprofiles","metadata":{"seo":{"title":"List the existing plan profiles","description":"Retrieve plan profiles using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPlanProfiles","name":"List the existing plan profiles","isWebhook":false,"pointer":"/paths/~1plan-profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing plan profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve plan profiles using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_68","description":"The maximum amount of plan profiles that should be returned in the response"}],"pointer":"/paths/~1plan-profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plan-profiles","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":250,"schemaId":"schema_68"}],"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":"/plan-profiles","href":"plan-profiles/listplanprofiles","openApiOperationId":"listPlanProfiles","summary":"List the existing plan profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagePlanProfiles"}},"schemaId":"components/schemas/CursorPagePlanProfiles"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1plan-profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPagePlanProfiles","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPagePlanProfiles"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/plan-profiles"},{"label":"Create plan profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plan-profiles/createplanprofile","routeSlug":"/apis/plannings/planning-api/plan-profiles/createplanprofile","metadata":{"seo":{"title":"Create plan profile","description":"Create a new plan profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlanProfile","name":"Create plan profile","isWebhook":false,"pointer":"/paths/~1plan-profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create plan profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new plan profile\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"schemaId":"components/schemas/PlanProfile","pointer":"/paths/~1plan-profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/plan-profiles","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"responseCodes":["201","400","401"],"pointer":"/plan-profiles","href":"plan-profiles/createplanprofile","openApiOperationId":"createPlanProfile","summary":"Create plan profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/PlanProfile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"plan profile created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1plan-profiles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/plan-profiles"},{"label":"Get plan profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plan-profiles/getplanprofile","routeSlug":"/apis/plannings/planning-api/plan-profiles/getplanprofile","metadata":{"seo":{"title":"Get plan profile","description":"Retrieves detailed information on the given plan profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlanProfile","name":"Get plan profile","isWebhook":false,"pointer":"/paths/~1plan-profiles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get plan profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given plan profile.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1plan-profiles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/plan-profiles/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/plan-profiles/{id}","href":"plan-profiles/getplanprofile","openApiOperationId":"getPlanProfile","summary":"Get plan profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"schemaId":"components/schemas/PlanProfile","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1plan-profiles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlanProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanProfile"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/plan-profiles/{id}"},{"label":"Upsert plan profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plan-profiles/upsertplanprofile","routeSlug":"/apis/plannings/planning-api/plan-profiles/upsertplanprofile","metadata":{"seo":{"title":"Upsert plan profile","description":"Create or update a plan profile. A unique ID is required to identify the plan profile. Calling this endpoint with an existing ID will update the plan profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertPlanProfile","name":"Upsert plan profile","isWebhook":false,"pointer":"/paths/~1plan-profiles~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert plan profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a plan profile. A unique ID is required to identify the plan profile.\nCalling this endpoint with an existing ID will update the plan profile.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1plan-profiles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1plan-profiles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"schemaId":"components/schemas/PlanProfile","pointer":"/paths/~1plan-profiles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/plan-profiles/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/PlanProfile"}},"responseCodes":["201","204","400","401","412"],"pointer":"/plan-profiles/{id}","href":"plan-profiles/upsertplanprofile","openApiOperationId":"upsertPlanProfile","summary":"Upsert plan profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/PlanProfile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlanProfile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"plan profile created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"plan profile updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1plan-profiles~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/plan-profiles/{id}"},{"label":"Delete plan profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/plan-profiles/deleteplanprofile","routeSlug":"/apis/plannings/planning-api/plan-profiles/deleteplanprofile","metadata":{"seo":{"title":"Delete plan profile","description":"Delete a plan profile by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePlanProfile","name":"Delete plan profile","isWebhook":false,"pointer":"/paths/~1plan-profiles~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete plan profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a plan profile by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1plan-profiles~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1plan-profiles~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/plan-profiles/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/plan-profiles/{id}","href":"plan-profiles/deleteplanprofile","openApiOperationId":"deletePlanProfile","summary":"Delete plan profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1plan-profiles~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/plan-profiles/{id}"}],"content":{"contentType":"group","meta":{"name":"plan-profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plan Profiles","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing plan profiles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/plan-profiles","summary":"List the existing plan profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plan-profiles/listplanprofiles","deprecated":false},{"title":"/plan-profiles","summary":"Create plan profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plan-profiles/createplanprofile","deprecated":false},{"title":"/plan-profiles/{id}","summary":"Get plan profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plan-profiles/getplanprofile","deprecated":false},{"title":"/plan-profiles/{id}","summary":"Upsert plan profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/plan-profiles/upsertplanprofile","deprecated":false},{"title":"/plan-profiles/{id}","summary":"Delete plan profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/plan-profiles/deleteplanprofile","deprecated":false}]}]}]}]}},{"type":"separator","label":"Settings","content":null},{"type":"group","label":"Location Workload Levelling","link":"/apis/plannings/planning-api/location-workload-levelling","routeSlug":"/apis/plannings/planning-api/location-workload-levelling","items":[{"label":"List the existing location workload levelling sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-workload-levelling/listlocationworkloadlevellingsets","routeSlug":"/apis/plannings/planning-api/location-workload-levelling/listlocationworkloadlevellingsets","metadata":{"seo":{"title":"List the existing location workload levelling sets","description":"Retrieves detailed information on all location workload levelling sets, limited to at most 100 items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLocationWorkloadLevellingSets","name":"List the existing location workload levelling sets","isWebhook":false,"pointer":"/paths/~1settings~1location-workload-levelling-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing location workload levelling sets","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 detailed information on all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s, limited to at most 100 items."},"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 and 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_65","description":"Cursor of the page to retrieve."},{"name":"limit","in":"query","schemaId":"schema_73","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s that should be returned in the response"},"children":[]}]}]}]}],"pointer":"/paths/~1settings~1location-workload-levelling-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/location-workload-levelling-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_73"}],"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":"/settings/location-workload-levelling-sets","href":"location-workload-levelling/listlocationworkloadlevellingsets","openApiOperationId":"listLocationWorkloadLevellingSets","summary":"List the existing location workload levelling sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageLocationWorkloadLevellingSets"}},"schemaId":"components/schemas/CursorPageLocationWorkloadLevellingSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1location-workload-levelling-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageLocationWorkloadLevellingSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageLocationWorkloadLevellingSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/location-workload-levelling-sets"},{"label":"Get location workload levelling set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-workload-levelling/getlocationworkloadlevellingset","routeSlug":"/apis/plannings/planning-api/location-workload-levelling/getlocationworkloadlevellingset","metadata":{"seo":{"title":"Get location workload levelling set","description":"Retrieves detailed information on the given location workload levelling set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationWorkloadLevellingSet","name":"Get location workload levelling set","isWebhook":false,"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location workload levelling set","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 detailed information on the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"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 and 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":"business_id","in":"path","schemaId":"schema_74","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/location-workload-levelling-sets/{business_id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_74"}],"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":"/settings/location-workload-levelling-sets/{business_id}","href":"location-workload-levelling/getlocationworkloadlevellingset","openApiOperationId":"getLocationWorkloadLevellingSet","summary":"Get location workload levelling set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationWorkloadLevellingSet"}},"schemaId":"components/schemas/LocationWorkloadLevellingSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1location-workload-levelling-sets~1{business_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationWorkloadLevellingSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationWorkloadLevellingSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/location-workload-levelling-sets/{business_id}"},{"label":"Upsert location workload levelling set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-workload-levelling/upsertlocationworkloadlevellingset","routeSlug":"/apis/plannings/planning-api/location-workload-levelling/upsertlocationworkloadlevellingset","metadata":{"seo":{"title":"Upsert location workload levelling set","description":"Create or update a location workload levelling set. A unique ID (business_id) is required to identify the location workload levelling set.Calling this endpoint with an existing business_id will update the location workload levelling set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertLocationWorkloadLevellingSet","name":"Upsert location workload levelling set","isWebhook":false,"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert location workload levelling set","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":"location workload levelling set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A unique ID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is required to identify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"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":"Calling this endpoint with an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"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 and 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":"business_id","in":"path","schemaId":"schema_74","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationWorkloadLevellingSet"}},"schemaId":"components/schemas/LocationWorkloadLevellingSet","pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/location-workload-levelling-sets/{business_id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_74"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/LocationWorkloadLevellingSet"}},"responseCodes":["201","204","400","401","404","409","412"],"pointer":"/settings/location-workload-levelling-sets/{business_id}","href":"location-workload-levelling/upsertlocationworkloadlevellingset","openApiOperationId":"upsertLocationWorkloadLevellingSet","summary":"Upsert location workload levelling set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/LocationWorkloadLevellingSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationWorkloadLevellingSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"location workload levelling set created successful","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"description":"The URL of the newly created resource","schema":{"type":"string","example":"/settings/location-workload-levelling-sets/86b54c9d-21d7-4b37-af3d-25f03886153b"}}},"headerSchemaId":"schema_75"},{"code":"204","description":"location workload levelling set updated successful","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/location-workload-levelling-sets/{business_id}"},{"label":"Delete location workload levelling set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-workload-levelling/deletelocationworkloadlevellingset","routeSlug":"/apis/plannings/planning-api/location-workload-levelling/deletelocationworkloadlevellingset","metadata":{"seo":{"title":"Delete location workload levelling set","description":"Delete a location workload levelling set by its business_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLocationWorkloadLevellingSet","name":"Delete location workload levelling set","isWebhook":false,"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete location workload levelling set","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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location workload levelling set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_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 and 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":"business_id","in":"path","schemaId":"schema_74","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/location-workload-levelling-sets/{business_id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"business_id","in":"path","required":true,"schemaId":"schema_74"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/location-workload-levelling-sets/{business_id}","href":"location-workload-levelling/deletelocationworkloadlevellingset","openApiOperationId":"deleteLocationWorkloadLevellingSet","summary":"Delete location workload levelling set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1location-workload-levelling-sets~1{business_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/location-workload-levelling-sets/{business_id}"}],"content":{"contentType":"group","meta":{"name":"location-workload-levelling"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Workload Levelling","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing location workload levelling sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/location-workload-levelling-sets","summary":"List the existing location workload levelling sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-workload-levelling/listlocationworkloadlevellingsets","deprecated":false},{"title":"/settings/location-workload-levelling-sets/{business_id}","summary":"Get location workload levelling set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-workload-levelling/getlocationworkloadlevellingset","deprecated":false},{"title":"/settings/location-workload-levelling-sets/{business_id}","summary":"Upsert location workload levelling set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/location-workload-levelling/upsertlocationworkloadlevellingset","deprecated":false},{"title":"/settings/location-workload-levelling-sets/{business_id}","summary":"Delete location workload levelling set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/location-workload-levelling/deletelocationworkloadlevellingset","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Order Restrictions","link":"/apis/plannings/planning-api/order-order-restrictions","routeSlug":"/apis/plannings/planning-api/order-order-restrictions","items":[{"label":"List the existing order-order restriction sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-order-restrictions/listorderorderrestrictionsets","routeSlug":"/apis/plannings/planning-api/order-order-restrictions/listorderorderrestrictionsets","metadata":{"seo":{"title":"List the existing order-order restriction sets","description":"Retrieve order-order restriction sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrderOrderRestrictionSets","name":"List the existing order-order restriction sets","isWebhook":false,"pointer":"/paths/~1settings~1order-order-restriction-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing order-order restriction sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve order-order restriction sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_67","description":"The maximum amount of order-order restriction sets that should be returned in the response."}],"pointer":"/paths/~1settings~1order-order-restriction-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-order-restriction-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_67"}],"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":"/settings/order-order-restriction-sets","href":"order-order-restrictions/listorderorderrestrictionsets","openApiOperationId":"listOrderOrderRestrictionSets","summary":"List the existing order-order restriction sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderOrderRestrictionSets"}},"schemaId":"components/schemas/CursorPageOrderOrderRestrictionSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-order-restriction-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageOrderOrderRestrictionSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderOrderRestrictionSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-order-restriction-sets"},{"label":"Create order-order restriction set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-order-restrictions/createorderorderrestrictionset","routeSlug":"/apis/plannings/planning-api/order-order-restrictions/createorderorderrestrictionset","metadata":{"seo":{"title":"Create order-order restriction set","description":"Create a new order-order restriction set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderOrderRestrictionSet","name":"Create order-order restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-order-restriction-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order-order restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new order-order restriction set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"schemaId":"components/schemas/OrderOrderRestrictionSet","pointer":"/paths/~1settings~1order-order-restriction-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/order-order-restriction-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"responseCodes":["201","400","401"],"pointer":"/settings/order-order-restriction-sets","href":"order-order-restrictions/createorderorderrestrictionset","openApiOperationId":"createOrderOrderRestrictionSet","summary":"Create order-order restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderOrderRestrictionSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-order restriction set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-order-restriction-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-order-restriction-sets"},{"label":"Get order-order restriction set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-order-restrictions/getorderorderrestrictionset","routeSlug":"/apis/plannings/planning-api/order-order-restrictions/getorderorderrestrictionset","metadata":{"seo":{"title":"Get order-order restriction set","description":"Retrieves detailed information on the given order-order restriction set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderOrderRestrictionSet","name":"Get order-order restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order-order restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given order-order restriction set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-order-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/order-order-restriction-sets/{id}","href":"order-order-restrictions/getorderorderrestrictionset","openApiOperationId":"getOrderOrderRestrictionSet","summary":"Get order-order restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"schemaId":"components/schemas/OrderOrderRestrictionSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1order-order-restriction-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderOrderRestrictionSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-order-restriction-sets/{id}"},{"label":"Upsert order-order restriction set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-order-restrictions/upsertorderorderrestrictionset","routeSlug":"/apis/plannings/planning-api/order-order-restrictions/upsertorderorderrestrictionset","metadata":{"seo":{"title":"Upsert order-order restriction set","description":"Create or update an order-order restriction set. A unique ID is required to identify the order-order restriction set. Calling this endpoint with an existing ID will update the order-order restriction set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertOrderOrderRestrictionSet","name":"Upsert order-order restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert order-order restriction set","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 order-order restriction set. A unique ID is required to identify the order-order restriction set.\nCalling this endpoint with an existing ID will update the order-order restriction set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"schemaId":"components/schemas/OrderOrderRestrictionSet","pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/order-order-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/OrderOrderRestrictionSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/order-order-restriction-sets/{id}","href":"order-order-restrictions/upsertorderorderrestrictionset","openApiOperationId":"upsertOrderOrderRestrictionSet","summary":"Upsert order-order restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderOrderRestrictionSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderOrderRestrictionSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-order restriction set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"order-order restriction set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-order-restriction-sets/{id}"},{"label":"Delete order-order restriction set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-order-restrictions/deleteorderorderrestrictionset","routeSlug":"/apis/plannings/planning-api/order-order-restrictions/deleteorderorderrestrictionset","metadata":{"seo":{"title":"Delete order-order restriction set","description":"Delete an order-order restriction set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderOrderRestrictionSet","name":"Delete order-order restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order-order restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an order-order restriction set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/order-order-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/order-order-restriction-sets/{id}","href":"order-order-restrictions/deleteorderorderrestrictionset","openApiOperationId":"deleteOrderOrderRestrictionSet","summary":"Delete order-order restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-order-restriction-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/order-order-restriction-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"order-order-restrictions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Order Restrictions","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing order-order restriction sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/order-order-restriction-sets","summary":"List the existing order-order restriction sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-order-restrictions/listorderorderrestrictionsets","deprecated":false},{"title":"/settings/order-order-restriction-sets","summary":"Create order-order restriction set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-order-restrictions/createorderorderrestrictionset","deprecated":false},{"title":"/settings/order-order-restriction-sets/{id}","summary":"Get order-order restriction set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-order-restrictions/getorderorderrestrictionset","deprecated":false},{"title":"/settings/order-order-restriction-sets/{id}","summary":"Upsert order-order restriction set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-order-restrictions/upsertorderorderrestrictionset","deprecated":false},{"title":"/settings/order-order-restriction-sets/{id}","summary":"Delete order-order restriction set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-order-restrictions/deleteorderorderrestrictionset","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Depot Restrictions","link":"/apis/plannings/planning-api/order-depot-restrictions","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions","items":[{"label":"List the existing order-depot restriction sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-depot-restrictions/listorderdepotrestrictionsets","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions/listorderdepotrestrictionsets","metadata":{"seo":{"title":"List the existing order-depot restriction sets","description":"Retrieve order-depot restriction sets using cursor-based paging. (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrderDepotRestrictionSets","name":"List the existing order-depot restriction sets","isWebhook":false,"pointer":"/paths/~1settings~1order-depot-restriction-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing order-depot restriction sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve order-depot restriction sets using cursor-based paging. (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_67","description":"The maximum amount of order-depot restriction sets that should be returned in the response."}],"pointer":"/paths/~1settings~1order-depot-restriction-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-depot-restriction-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_67"}],"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":"/settings/order-depot-restriction-sets","href":"order-depot-restrictions/listorderdepotrestrictionsets","openApiOperationId":"listOrderDepotRestrictionSets","summary":"List the existing order-depot restriction sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderDepotRestrictionSets"}},"schemaId":"components/schemas/CursorPageOrderDepotRestrictionSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-depot-restriction-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageOrderDepotRestrictionSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderDepotRestrictionSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-depot-restriction-sets"},{"label":"Create order-depot restriction set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-depot-restrictions/createorderdepotrestrictionset","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions/createorderdepotrestrictionset","metadata":{"seo":{"title":"Create order-depot restriction set","description":"Create a new order-depot restriction set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderDepotRestrictionSet","name":"Create order-depot restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-depot-restriction-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order-depot restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new order-depot restriction set.\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"schemaId":"components/schemas/OrderDepotRestrictionSet","pointer":"/paths/~1settings~1order-depot-restriction-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/order-depot-restriction-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"responseCodes":["201","400","401"],"pointer":"/settings/order-depot-restriction-sets","href":"order-depot-restrictions/createorderdepotrestrictionset","openApiOperationId":"createOrderDepotRestrictionSet","summary":"Create order-depot restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderDepotRestrictionSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-depot restriction set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-depot-restriction-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-depot-restriction-sets"},{"label":"Get order-depot restriction set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-depot-restrictions/getorderdepotrestrictionset","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions/getorderdepotrestrictionset","metadata":{"seo":{"title":"Get order-depot restriction set","description":"Retrieves detailed information on the given order-depot restriction set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderDepotRestrictionSet","name":"Get order-depot restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order-depot restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given order-depot restriction set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-depot-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/order-depot-restriction-sets/{id}","href":"order-depot-restrictions/getorderdepotrestrictionset","openApiOperationId":"getOrderDepotRestrictionSet","summary":"Get order-depot restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"schemaId":"components/schemas/OrderDepotRestrictionSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1order-depot-restriction-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderDepotRestrictionSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-depot-restriction-sets/{id}"},{"label":"Upsert order-depot restriction set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-depot-restrictions/upsertorderdepotrestrictionset","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions/upsertorderdepotrestrictionset","metadata":{"seo":{"title":"Upsert order-depot restriction set","description":"Create or update an order-depot restriction set. A unique ID is required to identify the set. Calling this endpoint with an existing ID will update the set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertOrderDepotRestrictionSet","name":"Upsert order-depot restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert order-depot restriction set","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 order-depot restriction set. A unique ID is required to identify the set.\nCalling this endpoint with an existing ID will update the set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"schemaId":"components/schemas/OrderDepotRestrictionSet","pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/order-depot-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/OrderDepotRestrictionSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/order-depot-restriction-sets/{id}","href":"order-depot-restrictions/upsertorderdepotrestrictionset","openApiOperationId":"upsertOrderDepotRestrictionSet","summary":"Upsert order-depot restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderDepotRestrictionSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDepotRestrictionSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-depot restriction set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"order-depot restriction set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-depot-restriction-sets/{id}"},{"label":"Delete order-depot restriction set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-depot-restrictions/deleteorderdepotrestrictionset","routeSlug":"/apis/plannings/planning-api/order-depot-restrictions/deleteorderdepotrestrictionset","metadata":{"seo":{"title":"Delete order-depot restriction set","description":"Delete an order-depot restriction set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderDepotRestrictionSet","name":"Delete order-depot restriction set","isWebhook":false,"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order-depot restriction set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an order-depot restriction set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/order-depot-restriction-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/order-depot-restriction-sets/{id}","href":"order-depot-restrictions/deleteorderdepotrestrictionset","openApiOperationId":"deleteOrderDepotRestrictionSet","summary":"Delete order-depot restriction set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-depot-restriction-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/order-depot-restriction-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"order-depot-restrictions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Depot Restrictions","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing order-depot restriction sets.\n\nOrder-depot restrictions define constraints on which orders can be (un)loaded at which depots, based on order labels and depot labels."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/order-depot-restriction-sets","summary":"List the existing order-depot restriction sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-depot-restrictions/listorderdepotrestrictionsets","deprecated":false},{"title":"/settings/order-depot-restriction-sets","summary":"Create order-depot restriction set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-depot-restrictions/createorderdepotrestrictionset","deprecated":false},{"title":"/settings/order-depot-restriction-sets/{id}","summary":"Get order-depot restriction set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-depot-restrictions/getorderdepotrestrictionset","deprecated":false},{"title":"/settings/order-depot-restriction-sets/{id}","summary":"Upsert order-depot restriction set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-depot-restrictions/upsertorderdepotrestrictionset","deprecated":false},{"title":"/settings/order-depot-restriction-sets/{id}","summary":"Delete order-depot restriction set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-depot-restrictions/deleteorderdepotrestrictionset","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Vehicle Preferences","link":"/apis/plannings/planning-api/order-vehicle-preferences","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences","items":[{"label":"List the existing order-vehicle preference sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-vehicle-preferences/listordervehiclepreferencesets","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences/listordervehiclepreferencesets","metadata":{"seo":{"title":"List the existing order-vehicle preference sets","description":"Retrieve order-vehicle preference sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrderVehiclePreferenceSets","name":"List the existing order-vehicle preference sets","isWebhook":false,"pointer":"/paths/~1settings~1order-vehicle-preference-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing order-vehicle preference sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve order-vehicle preference sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_67","description":"The maximum amount of order-vehicle preference sets that should be returned in the response"}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-vehicle-preference-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_67"}],"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":"/settings/order-vehicle-preference-sets","href":"order-vehicle-preferences/listordervehiclepreferencesets","openApiOperationId":"listOrderVehiclePreferenceSets","summary":"List the existing order-vehicle preference sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderVehiclePreferenceSets"}},"schemaId":"components/schemas/CursorPageOrderVehiclePreferenceSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageOrderVehiclePreferenceSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageOrderVehiclePreferenceSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-vehicle-preference-sets"},{"label":"Create order-vehicle preference set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-vehicle-preferences/createordervehiclepreferenceset","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences/createordervehiclepreferenceset","metadata":{"seo":{"title":"Create order-vehicle preference set","description":"Create a new order-vehicle preference set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderVehiclePreferenceSet","name":"Create order-vehicle preference set","isWebhook":false,"pointer":"/paths/~1settings~1order-vehicle-preference-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order-vehicle preference set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new order-vehicle preference set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"schemaId":"components/schemas/OrderVehiclePreferenceSet","pointer":"/paths/~1settings~1order-vehicle-preference-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/order-vehicle-preference-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"responseCodes":["201","400","401"],"pointer":"/settings/order-vehicle-preference-sets","href":"order-vehicle-preferences/createordervehiclepreferenceset","openApiOperationId":"createOrderVehiclePreferenceSet","summary":"Create order-vehicle preference set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderVehiclePreferenceSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-vehicle preference set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/order-vehicle-preference-sets"},{"label":"Get order-vehicle preference set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-vehicle-preferences/getordervehiclepreferenceset","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences/getordervehiclepreferenceset","metadata":{"seo":{"title":"Get order-vehicle preference set","description":"Retrieves detailed information on the given order-vehicle preference set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderVehiclePreferenceSet","name":"Get order-vehicle preference set","isWebhook":false,"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order-vehicle preference set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given order-vehicle preference set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/order-vehicle-preference-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/order-vehicle-preference-sets/{id}","href":"order-vehicle-preferences/getordervehiclepreferenceset","openApiOperationId":"getOrderVehiclePreferenceSet","summary":"Get order-vehicle preference set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"schemaId":"components/schemas/OrderVehiclePreferenceSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1order-vehicle-preference-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderVehiclePreferenceSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-vehicle-preference-sets/{id}"},{"label":"Upsert order-vehicle preference set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-vehicle-preferences/upsertordervehiclepreferenceset","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences/upsertordervehiclepreferenceset","metadata":{"seo":{"title":"Upsert order-vehicle preference set","description":"Create or update an order-vehicle preference set. A unique ID is required to identify the order-vehicle preference set. Calling this endpoint with an existing ID will update the order-vehicle preference set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertOrderVehiclePreferenceSet","name":"Upsert order-vehicle preference set","isWebhook":false,"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert order-vehicle preference set","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 order-vehicle preference set. A unique ID is required to identify the order-vehicle preference set.\nCalling this endpoint with an existing ID will update the order-vehicle preference set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"schemaId":"components/schemas/OrderVehiclePreferenceSet","pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/order-vehicle-preference-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/OrderVehiclePreferenceSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/order-vehicle-preference-sets/{id}","href":"order-vehicle-preferences/upsertordervehiclepreferenceset","openApiOperationId":"upsertOrderVehiclePreferenceSet","summary":"Upsert order-vehicle preference set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/OrderVehiclePreferenceSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderVehiclePreferenceSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"order-vehicle preference set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"order-vehicle preference set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/order-vehicle-preference-sets/{id}"},{"label":"Delete order-vehicle preference set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/order-vehicle-preferences/deleteordervehiclepreferenceset","routeSlug":"/apis/plannings/planning-api/order-vehicle-preferences/deleteordervehiclepreferenceset","metadata":{"seo":{"title":"Delete order-vehicle preference set","description":"Delete an order-vehicle preference set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderVehiclePreferenceSet","name":"Delete order-vehicle preference set","isWebhook":false,"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order-vehicle preference set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an order-vehicle preference set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/order-vehicle-preference-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/order-vehicle-preference-sets/{id}","href":"order-vehicle-preferences/deleteordervehiclepreferenceset","openApiOperationId":"deleteOrderVehiclePreferenceSet","summary":"Delete order-vehicle preference set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1order-vehicle-preference-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/order-vehicle-preference-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"order-vehicle-preferences"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Vehicle Preferences","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 order-vehicle preference sets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order-vehicle preferences define soft constraints between orders and vehicles based on labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each preference rule links an order label to a vehicle label with a specific relationship type and a fine (penalty cost)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is applied when the preference is violated during planning."},"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":"Preference types:"},"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":"code","inline":true,"attributes":{"content":"FORBIDDEN_COMBINATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Orders with the specified label are penalized when assigned to vehicles with the specified label."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_REQUIRES_VEHICLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Orders with the specified label prefer vehicles with the specified label; a fine is applied if assigned to a different vehicle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VEHICLE_REQUIRES_ORDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Vehicles with the specified label prefer orders with the specified label; a fine is applied if assigned different orders."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/order-vehicle-preference-sets","summary":"List the existing order-vehicle preference sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-vehicle-preferences/listordervehiclepreferencesets","deprecated":false},{"title":"/settings/order-vehicle-preference-sets","summary":"Create order-vehicle preference set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-vehicle-preferences/createordervehiclepreferenceset","deprecated":false},{"title":"/settings/order-vehicle-preference-sets/{id}","summary":"Get order-vehicle preference set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-vehicle-preferences/getordervehiclepreferenceset","deprecated":false},{"title":"/settings/order-vehicle-preference-sets/{id}","summary":"Upsert order-vehicle preference set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-vehicle-preferences/upsertordervehiclepreferenceset","deprecated":false},{"title":"/settings/order-vehicle-preference-sets/{id}","summary":"Delete order-vehicle preference set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-vehicle-preferences/deleteordervehiclepreferenceset","deprecated":false}]}]}]}]}},{"type":"group","label":"Break Rules","link":"/apis/plannings/planning-api/break-rules","routeSlug":"/apis/plannings/planning-api/break-rules","items":[{"label":"List the existing break rule sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/break-rules/listbreakrulesets","routeSlug":"/apis/plannings/planning-api/break-rules/listbreakrulesets","metadata":{"seo":{"title":"List the existing break rule sets","description":"Retrieves detailed information on all break rule sets, limited to at most 100 items."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBreakRuleSets","name":"List the existing break rule sets","isWebhook":false,"pointer":"/paths/~1settings~1break-rule-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing break rule sets","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 detailed information on all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"break rule set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s, limited to at most 100 items."},"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 and 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_65","description":"Cursor of the page to retrieve."},{"name":"limit","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum amount of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"break rule set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s that should be returned in the response"},"children":[]}]}]}]}],"pointer":"/paths/~1settings~1break-rule-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/break-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_67"}],"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":"/settings/break-rule-sets","href":"break-rules/listbreakrulesets","openApiOperationId":"listBreakRuleSets","summary":"List the existing break rule sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageBreakRuleSets"}},"schemaId":"components/schemas/CursorPageBreakRuleSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1break-rule-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageBreakRuleSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageBreakRuleSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/break-rule-sets"},{"label":"Create break rule set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/break-rules/createbreakruleset","routeSlug":"/apis/plannings/planning-api/break-rules/createbreakruleset","metadata":{"seo":{"title":"Create break rule set","description":"Create a new break rule set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBreakRuleSet","name":"Create break rule set","isWebhook":false,"pointer":"/paths/~1settings~1break-rule-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create break rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new break rule set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BreakRuleSetUpsertRequest"}},"schemaId":"components/schemas/BreakRuleSetUpsertRequest","pointer":"/paths/~1settings~1break-rule-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/break-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BreakRuleSetUpsertRequest"}},"responseCodes":["201","400","401"],"pointer":"/settings/break-rule-sets","href":"break-rules/createbreakruleset","openApiOperationId":"createBreakRuleSet","summary":"Create break rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/BreakRuleSetUpsertRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BreakRuleSetUpsertRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"break rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1break-rule-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/break-rule-sets"},{"label":"Get break rule set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/break-rules/getbreakruleset","routeSlug":"/apis/plannings/planning-api/break-rules/getbreakruleset","metadata":{"seo":{"title":"Get break rule set","description":"Retrieves detailed information on the given break rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBreakRuleSet","name":"Get break rule set","isWebhook":false,"pointer":"/paths/~1settings~1break-rule-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get break rule set","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 detailed information on the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"break rule set"},"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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/break-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/break-rule-sets/{id}","href":"break-rules/getbreakruleset","openApiOperationId":"getBreakRuleSet","summary":"Get break rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BreakRuleSet"}},"schemaId":"components/schemas/BreakRuleSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1break-rule-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BreakRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BreakRuleSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/break-rule-sets/{id}"},{"label":"Upsert break rule set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/break-rules/upsertbreakruleset","routeSlug":"/apis/plannings/planning-api/break-rules/upsertbreakruleset","metadata":{"seo":{"title":"Upsert break rule set","description":"Create or update a break rule set. A unique ID is required to identify the break rule set.Calling this endpoint with an existing ID will update the break rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertBreakRuleSet","name":"Upsert break rule set","isWebhook":false,"pointer":"/paths/~1settings~1break-rule-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert break rule set","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":"break rule set"},"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":"break rule set"},"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":"Calling this endpoint with an existing ID will update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"break rule set"},"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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BreakRuleSetUpsertRequest"}},"schemaId":"components/schemas/BreakRuleSetUpsertRequest","pointer":"/paths/~1settings~1break-rule-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/break-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/BreakRuleSetUpsertRequest"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/break-rule-sets/{id}","href":"break-rules/upsertbreakruleset","openApiOperationId":"upsertBreakRuleSet","summary":"Upsert break rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/BreakRuleSetUpsertRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BreakRuleSetUpsertRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"break rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"break rule set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/break-rule-sets/{id}"},{"label":"Delete break rule set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/break-rules/deletebreakruleset","routeSlug":"/apis/plannings/planning-api/break-rules/deletebreakruleset","metadata":{"seo":{"title":"Delete break rule set","description":"Delete a break rule set by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBreakRuleSet","name":"Delete break rule set","isWebhook":false,"pointer":"/paths/~1settings~1break-rule-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete break rule set","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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"break rule set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its "},"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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/break-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/break-rule-sets/{id}","href":"break-rules/deletebreakruleset","openApiOperationId":"deleteBreakRuleSet","summary":"Delete break rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1break-rule-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/break-rule-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"break-rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Break Rules","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing break rule sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/break-rule-sets","summary":"List the existing break rule sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/break-rules/listbreakrulesets","deprecated":false},{"title":"/settings/break-rule-sets","summary":"Create break rule set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/break-rules/createbreakruleset","deprecated":false},{"title":"/settings/break-rule-sets/{id}","summary":"Get break rule set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/break-rules/getbreakruleset","deprecated":false},{"title":"/settings/break-rule-sets/{id}","summary":"Upsert break rule set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/break-rules/upsertbreakruleset","deprecated":false},{"title":"/settings/break-rule-sets/{id}","summary":"Delete break rule set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/break-rules/deletebreakruleset","deprecated":false}]}]}]}]}},{"type":"group","label":"[EXPERIMENTAL] Location Rule Sets","link":"/apis/plannings/planning-api/location-rule-sets","routeSlug":"/apis/plannings/planning-api/location-rule-sets","items":[{"label":"List the existing location rule sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-rule-sets/listlocationrulesets","routeSlug":"/apis/plannings/planning-api/location-rule-sets/listlocationrulesets","metadata":{"seo":{"title":"List the existing location rule sets","description":"Retrieve location rule sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLocationRuleSets","name":"List the existing location rule sets","isWebhook":false,"pointer":"/paths/~1settings~1location-rule-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing location rule sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve location rule sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_68","description":"The maximum amount of location rule sets that should be returned in the response"}],"pointer":"/paths/~1settings~1location-rule-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/location-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":250,"schemaId":"schema_68"}],"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":"/settings/location-rule-sets","href":"location-rule-sets/listlocationrulesets","openApiOperationId":"listLocationRuleSets","summary":"List the existing location rule sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageLocationRuleSets"}},"schemaId":"components/schemas/CursorPageLocationRuleSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1location-rule-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageLocationRuleSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageLocationRuleSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/location-rule-sets"},{"label":"Create location rule set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-rule-sets/createlocationruleset","routeSlug":"/apis/plannings/planning-api/location-rule-sets/createlocationruleset","metadata":{"seo":{"title":"Create location rule set","description":"Create a new location rule set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLocationRuleSet","name":"Create location rule set","isWebhook":false,"pointer":"/paths/~1settings~1location-rule-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create location rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new location rule set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"schemaId":"components/schemas/LocationRuleSet","pointer":"/paths/~1settings~1location-rule-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/location-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"responseCodes":["201","400","401"],"pointer":"/settings/location-rule-sets","href":"location-rule-sets/createlocationruleset","openApiOperationId":"createLocationRuleSet","summary":"Create location rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/LocationRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"location rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1location-rule-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/location-rule-sets"},{"label":"Get location rule set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-rule-sets/getlocationruleset","routeSlug":"/apis/plannings/planning-api/location-rule-sets/getlocationruleset","metadata":{"seo":{"title":"Get location rule set","description":"Retrieves detailed information on the given location rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLocationRuleSet","name":"Get location rule set","isWebhook":false,"pointer":"/paths/~1settings~1location-rule-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given location rule set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/location-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/location-rule-sets/{id}","href":"location-rule-sets/getlocationruleset","openApiOperationId":"getLocationRuleSet","summary":"Get location rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"schemaId":"components/schemas/LocationRuleSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1location-rule-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LocationRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/location-rule-sets/{id}"},{"label":"Upsert location rule set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-rule-sets/upsertlocationruleset","routeSlug":"/apis/plannings/planning-api/location-rule-sets/upsertlocationruleset","metadata":{"seo":{"title":"Upsert location rule set","description":"Create or update a location rule set. A unique ID is required to identify the location rule set. Calling this endpoint with an existing ID will update the location rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertLocationRuleSet","name":"Upsert location rule set","isWebhook":false,"pointer":"/paths/~1settings~1location-rule-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert location rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a location rule set. A unique ID is required to identify the location rule set.\nCalling this endpoint with an existing ID will update the location rule set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"schemaId":"components/schemas/LocationRuleSet","pointer":"/paths/~1settings~1location-rule-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/location-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/LocationRuleSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/location-rule-sets/{id}","href":"location-rule-sets/upsertlocationruleset","openApiOperationId":"upsertLocationRuleSet","summary":"Upsert location rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/LocationRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LocationRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"location rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"location rule set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/location-rule-sets/{id}"},{"label":"Delete location rule set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/location-rule-sets/deletelocationruleset","routeSlug":"/apis/plannings/planning-api/location-rule-sets/deletelocationruleset","metadata":{"seo":{"title":"Delete location rule set","description":"Delete a location rule set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLocationRuleSet","name":"Delete location rule set","isWebhook":false,"pointer":"/paths/~1settings~1location-rule-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete location rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a location rule set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/location-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/location-rule-sets/{id}","href":"location-rule-sets/deletelocationruleset","openApiOperationId":"deleteLocationRuleSet","summary":"Delete location rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1location-rule-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/location-rule-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"location-rule-sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Location Rule Sets","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing location rule sets.\nLocation rules can be used to adjust stop times automatically based on the current stop, the previous stop, or broader operational context.\nEach matching rule can multiply the base stop time, add a fixed duration, or do both."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/location-rule-sets","summary":"List the existing location rule sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-rule-sets/listlocationrulesets","deprecated":false},{"title":"/settings/location-rule-sets","summary":"Create location rule set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/location-rule-sets/createlocationruleset","deprecated":false},{"title":"/settings/location-rule-sets/{id}","summary":"Get location rule set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/location-rule-sets/getlocationruleset","deprecated":false},{"title":"/settings/location-rule-sets/{id}","summary":"Upsert location rule set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/location-rule-sets/upsertlocationruleset","deprecated":false},{"title":"/settings/location-rule-sets/{id}","summary":"Delete location rule set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/location-rule-sets/deletelocationruleset","deprecated":false}]}]}]}]}},{"type":"group","label":"[EXPERIMENTAL] Vehicle Stop Rules","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets","items":[{"label":"List the existing vehicle stop rule sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets/listvehiclestoprulesets","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets/listvehiclestoprulesets","metadata":{"seo":{"title":"List the existing vehicle stop rule sets","description":"Retrieve vehicle stop rule sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVehicleStopRuleSets","name":"List the existing vehicle stop rule sets","isWebhook":false,"pointer":"/paths/~1settings~1vehicle-stop-rule-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing vehicle stop rule sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve vehicle stop rule sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_67","description":"The maximum amount of vehicle stop rule sets that should be returned in the response"}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/vehicle-stop-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":100,"schemaId":"schema_67"}],"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":"/settings/vehicle-stop-rule-sets","href":"vehicle-stop-rule-sets/listvehiclestoprulesets","openApiOperationId":"listVehicleStopRuleSets","summary":"List the existing vehicle stop rule sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageVehicleStopRuleSets"}},"schemaId":"components/schemas/CursorPageVehicleStopRuleSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageVehicleStopRuleSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageVehicleStopRuleSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/vehicle-stop-rule-sets"},{"label":"Create vehicle stop rule set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets/createvehiclestopruleset","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets/createvehiclestopruleset","metadata":{"seo":{"title":"Create vehicle stop rule set","description":"Create a new vehicle stop rule set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVehicleStopRuleSet","name":"Create vehicle stop rule set","isWebhook":false,"pointer":"/paths/~1settings~1vehicle-stop-rule-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create vehicle stop rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new vehicle stop rule set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"schemaId":"components/schemas/VehicleStopRuleSet","pointer":"/paths/~1settings~1vehicle-stop-rule-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/vehicle-stop-rule-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"responseCodes":["201","400","401"],"pointer":"/settings/vehicle-stop-rule-sets","href":"vehicle-stop-rule-sets/createvehiclestopruleset","openApiOperationId":"createVehicleStopRuleSet","summary":"Create vehicle stop rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/VehicleStopRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"vehicle stop rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/settings/vehicle-stop-rule-sets"},{"label":"Get vehicle stop rule set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets/getvehiclestopruleset","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets/getvehiclestopruleset","metadata":{"seo":{"title":"Get vehicle stop rule set","description":"Retrieves detailed information on the given vehicle stop rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVehicleStopRuleSet","name":"Get vehicle stop rule set","isWebhook":false,"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vehicle stop rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given vehicle stop rule set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/vehicle-stop-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/settings/vehicle-stop-rule-sets/{id}","href":"vehicle-stop-rule-sets/getvehiclestopruleset","openApiOperationId":"getVehicleStopRuleSet","summary":"Get vehicle stop rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"schemaId":"components/schemas/VehicleStopRuleSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1settings~1vehicle-stop-rule-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VehicleStopRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/vehicle-stop-rule-sets/{id}"},{"label":"Upsert vehicle stop rule set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets/upsertvehiclestopruleset","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets/upsertvehiclestopruleset","metadata":{"seo":{"title":"Upsert vehicle stop rule set","description":"Create or update a vehicle stop rule set. A unique ID is required to identify the vehicle stop rule set. Calling this endpoint with an existing ID will update the vehicle stop rule set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertVehicleStopRuleSet","name":"Upsert vehicle stop rule set","isWebhook":false,"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert vehicle stop rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a vehicle stop rule set. A unique ID is required to identify the vehicle stop rule set.\nCalling this endpoint with an existing ID will update the vehicle stop rule set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"schemaId":"components/schemas/VehicleStopRuleSet","pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/vehicle-stop-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/VehicleStopRuleSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/settings/vehicle-stop-rule-sets/{id}","href":"vehicle-stop-rule-sets/upsertvehiclestopruleset","openApiOperationId":"upsertVehicleStopRuleSet","summary":"Upsert vehicle stop rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/VehicleStopRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VehicleStopRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"vehicle stop rule set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"vehicle stop rule set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/settings/vehicle-stop-rule-sets/{id}"},{"label":"Delete vehicle stop rule set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/vehicle-stop-rule-sets/deletevehiclestopruleset","routeSlug":"/apis/plannings/planning-api/vehicle-stop-rule-sets/deletevehiclestopruleset","metadata":{"seo":{"title":"Delete vehicle stop rule set","description":"Delete a vehicle stop rule set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVehicleStopRuleSet","name":"Delete vehicle stop rule set","isWebhook":false,"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete vehicle stop rule set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a vehicle stop rule set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/vehicle-stop-rule-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/settings/vehicle-stop-rule-sets/{id}","href":"vehicle-stop-rule-sets/deletevehiclestopruleset","openApiOperationId":"deleteVehicleStopRuleSet","summary":"Delete vehicle stop rule set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1settings~1vehicle-stop-rule-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/settings/vehicle-stop-rule-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"vehicle-stop-rule-sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"[EXPERIMENTAL] Vehicle Stop Rules","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing vehicle stop rule sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/vehicle-stop-rule-sets","summary":"List the existing vehicle stop rule sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicle-stop-rule-sets/listvehiclestoprulesets","deprecated":false},{"title":"/settings/vehicle-stop-rule-sets","summary":"Create vehicle stop rule set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vehicle-stop-rule-sets/createvehiclestopruleset","deprecated":false},{"title":"/settings/vehicle-stop-rule-sets/{id}","summary":"Get vehicle stop rule set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicle-stop-rule-sets/getvehiclestopruleset","deprecated":false},{"title":"/settings/vehicle-stop-rule-sets/{id}","summary":"Upsert vehicle stop rule set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/vehicle-stop-rule-sets/upsertvehiclestopruleset","deprecated":false},{"title":"/settings/vehicle-stop-rule-sets/{id}","summary":"Delete vehicle stop rule set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/vehicle-stop-rule-sets/deletevehiclestopruleset","deprecated":false}]}]}]}]}},{"type":"separator","label":"Locations","content":null},{"type":"group","label":"Depot Sets","link":"/apis/plannings/planning-api/depot-sets","routeSlug":"/apis/plannings/planning-api/depot-sets","items":[{"label":"List the existing depot sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/depot-sets/listdepotsets","routeSlug":"/apis/plannings/planning-api/depot-sets/listdepotsets","metadata":{"seo":{"title":"List the existing depot sets","description":"Retrieve depot sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDepotSets","name":"List the existing depot sets","isWebhook":false,"pointer":"/paths/~1locations~1depot-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing depot sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve depot sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_68","description":"The maximum amount of depot sets that should be returned in the response"}],"pointer":"/paths/~1locations~1depot-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/depot-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":250,"schemaId":"schema_68"}],"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":"/locations/depot-sets","href":"depot-sets/listdepotsets","openApiOperationId":"listDepotSets","summary":"List the existing depot sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageDepotSets"}},"schemaId":"components/schemas/CursorPageDepotSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1locations~1depot-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageDepotSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageDepotSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/locations/depot-sets"},{"label":"Create depot set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/depot-sets/createdepotset","routeSlug":"/apis/plannings/planning-api/depot-sets/createdepotset","metadata":{"seo":{"title":"Create depot set","description":"Create a new depot set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDepotSet","name":"Create depot set","isWebhook":false,"pointer":"/paths/~1locations~1depot-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create depot set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new depot set.\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"schemaId":"components/schemas/DepotSet","pointer":"/paths/~1locations~1depot-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/depot-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"responseCodes":["201","400","401"],"pointer":"/locations/depot-sets","href":"depot-sets/createdepotset","openApiOperationId":"createDepotSet","summary":"Create depot set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/DepotSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"depot set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1locations~1depot-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/locations/depot-sets"},{"label":"Get depot set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/depot-sets/getdepotset","routeSlug":"/apis/plannings/planning-api/depot-sets/getdepotset","metadata":{"seo":{"title":"Get depot set","description":"Retrieves detailed information on the given depot set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDepotSet","name":"Get depot set","isWebhook":false,"pointer":"/paths/~1locations~1depot-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get depot set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given depot set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1depot-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/depot-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/locations/depot-sets/{id}","href":"depot-sets/getdepotset","openApiOperationId":"getDepotSet","summary":"Get depot set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"schemaId":"components/schemas/DepotSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1locations~1depot-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DepotSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DepotSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/depot-sets/{id}"},{"label":"Upsert depot set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/depot-sets/upsertdepotset","routeSlug":"/apis/plannings/planning-api/depot-sets/upsertdepotset","metadata":{"seo":{"title":"Upsert depot set","description":"Create or update a depot set. A unique ID is required to identify the depot set. Calling this endpoint with an existing id will update the depot set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertDepotSet","name":"Upsert depot set","isWebhook":false,"pointer":"/paths/~1locations~1depot-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert depot set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a depot set. A unique ID is required to identify the depot set.\nCalling this endpoint with an existing id will update the depot set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1depot-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1locations~1depot-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"schemaId":"components/schemas/DepotSet","pointer":"/paths/~1locations~1depot-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/depot-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/DepotSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/locations/depot-sets/{id}","href":"depot-sets/upsertdepotset","openApiOperationId":"upsertDepotSet","summary":"Upsert depot set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/DepotSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DepotSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"depot set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"depot set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1depot-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/depot-sets/{id}"},{"label":"Delete depot set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/depot-sets/deletedepotset","routeSlug":"/apis/plannings/planning-api/depot-sets/deletedepotset","metadata":{"seo":{"title":"Delete depot set","description":"Delete a depot set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDepotSet","name":"Delete depot set","isWebhook":false,"pointer":"/paths/~1locations~1depot-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete depot set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a depot set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1depot-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1locations~1depot-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/depot-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/locations/depot-sets/{id}","href":"depot-sets/deletedepotset","openApiOperationId":"deleteDepotSet","summary":"Delete depot set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1depot-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/locations/depot-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"depot-sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Depot Sets","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints used for managing depot sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/depot-sets","summary":"List the existing depot sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/depot-sets/listdepotsets","deprecated":false},{"title":"/locations/depot-sets","summary":"Create depot set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/depot-sets/createdepotset","deprecated":false},{"title":"/locations/depot-sets/{id}","summary":"Get depot set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/depot-sets/getdepotset","deprecated":false},{"title":"/locations/depot-sets/{id}","summary":"Upsert depot set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/depot-sets/upsertdepotset","deprecated":false},{"title":"/locations/depot-sets/{id}","summary":"Delete depot set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/depot-sets/deletedepotset","deprecated":false}]}]}]}]}},{"type":"group","label":"Charging Location Sets","link":"/apis/plannings/planning-api/charging-location-sets","routeSlug":"/apis/plannings/planning-api/charging-location-sets","items":[{"label":"List the existing charging location sets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/charging-location-sets/listcharginglocationsets","routeSlug":"/apis/plannings/planning-api/charging-location-sets/listcharginglocationsets","metadata":{"seo":{"title":"List the existing charging location sets","description":"Retrieve charging location sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChargingLocationSets","name":"List the existing charging location sets","isWebhook":false,"pointer":"/paths/~1locations~1charging-location-sets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the existing charging location sets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve charging location sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).\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 and 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_65","description":"The cursor of the page to retrieve. No cursor is needed to retrieve the first page."},{"name":"limit","in":"query","schemaId":"schema_68","description":"The maximum amount of charging location sets that should be returned in the response"}],"pointer":"/paths/~1locations~1charging-location-sets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/charging-location-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_65"},{"name":"limit","in":"query","required":false,"example":250,"schemaId":"schema_68"}],"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":"/locations/charging-location-sets","href":"charging-location-sets/listcharginglocationsets","openApiOperationId":"listChargingLocationSets","summary":"List the existing charging location sets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageChargingLocationSets"}},"schemaId":"components/schemas/CursorPageChargingLocationSets"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1locations~1charging-location-sets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorPageChargingLocationSets","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorPageChargingLocationSets"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/locations/charging-location-sets"},{"label":"Create charging location set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/charging-location-sets/createcharginglocationset","routeSlug":"/apis/plannings/planning-api/charging-location-sets/createcharginglocationset","metadata":{"seo":{"title":"Create charging location set","description":"Create a new charging location set"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChargingLocationSet","name":"Create charging location set","isWebhook":false,"pointer":"/paths/~1locations~1charging-location-sets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create charging location set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new charging location set\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 and 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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"schemaId":"components/schemas/ChargingLocationSet","pointer":"/paths/~1locations~1charging-location-sets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/charging-location-sets","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"responseCodes":["201","400","401"],"pointer":"/locations/charging-location-sets","href":"charging-location-sets/createcharginglocationset","openApiOperationId":"createChargingLocationSet","summary":"Create charging location set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/ChargingLocationSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"charging location set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Location":{"$ref":"#/components/headers/Location"}},"headerSchemaId":"schema_69"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Authentication required"}],"pointer":"/paths/~1locations~1charging-location-sets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"}],"examples":[]}]}]}]},"httpPath":"/locations/charging-location-sets"},{"label":"Get charging location set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/charging-location-sets/getcharginglocationset","routeSlug":"/apis/plannings/planning-api/charging-location-sets/getcharginglocationset","metadata":{"seo":{"title":"Get charging location set","description":"Retrieves detailed information on the given charging location set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChargingLocationSet","name":"Get charging location set","isWebhook":false,"pointer":"/paths/~1locations~1charging-location-sets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get charging location set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves detailed information on the given charging location set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/charging-location-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"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":"/locations/charging-location-sets/{id}","href":"charging-location-sets/getcharginglocationset","openApiOperationId":"getChargingLocationSet","summary":"Get charging location set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"schemaId":"components/schemas/ChargingLocationSet","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"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/~1locations~1charging-location-sets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChargingLocationSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}}},{"code":"401"},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/charging-location-sets/{id}"},{"label":"Upsert charging location set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/charging-location-sets/upsertcharginglocationset","routeSlug":"/apis/plannings/planning-api/charging-location-sets/upsertcharginglocationset","metadata":{"seo":{"title":"Upsert charging location set","description":"Create or update a charging location set. A unique ID is required to identify the charging location set. Calling this endpoint with an existing ID will update the charging location set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertChargingLocationSet","name":"Upsert charging location set","isWebhook":false,"pointer":"/paths/~1locations~1charging-location-sets~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upsert charging location set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update a charging location set. A unique ID is required to identify the charging location set.\nCalling this endpoint with an existing ID will update the charging location set.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"schemaId":"components/schemas/ChargingLocationSet","pointer":"/paths/~1locations~1charging-location-sets~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/charging-location-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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/ChargingLocationSet"}},"responseCodes":["201","204","400","401","412"],"pointer":"/locations/charging-location-sets/{id}","href":"charging-location-sets/upsertcharginglocationset","openApiOperationId":"upsertChargingLocationSet","summary":"Upsert charging location set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"schemaId":"components/schemas/ChargingLocationSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargingLocationSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"charging location set created successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"204","description":"charging location set updated successfully","headers":{"ETag":{"$ref":"#/components/headers/ETag"}},"headerSchemaId":"schema_71"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401"},{"code":"412","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]}]},"httpPath":"/locations/charging-location-sets/{id}"},{"label":"Delete charging location set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/plannings/planning-api/charging-location-sets/deletecharginglocationset","routeSlug":"/apis/plannings/planning-api/charging-location-sets/deletecharginglocationset","metadata":{"seo":{"title":"Delete charging location set","description":"Delete a charging location set by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChargingLocationSet","name":"Delete charging location set","isWebhook":false,"pointer":"/paths/~1locations~1charging-location-sets~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete charging location set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a charging location set by its ID.\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 and 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_70","description":"The unique identifier of an entity","required":true}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"If-Match","in":"header","schemaId":"schema_72","description":"Weak Etag used for optimistic locking."}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/charging-location-sets/{id}","servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_70"}],"query":[],"querystring":[],"header":[{"name":"If-Match","in":"header","example":"W/\"24\"","schemaId":"schema_72"}],"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":"/locations/charging-location-sets/{id}","href":"charging-location-sets/deletecharginglocationset","openApiOperationId":"deleteChargingLocationSet","summary":"Delete charging location set"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/plannings/planning-api","description":"Mock server","isMockServer":true},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delete successful"},{"code":"400","description":"Bad request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"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.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1locations~1charging-location-sets~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"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":"/locations/charging-location-sets/{id}"}],"content":{"contentType":"group","meta":{"name":"charging-location-sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Charging Location Sets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"style":{"backgroundColor":"orange","color":"white","padding":"4px 8px","borderRadius":"5px","fontSize":"12px","fontWeight":"bold"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Access"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints used for managing charging location sets."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/charging-location-sets","summary":"List the existing charging location sets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/charging-location-sets/listcharginglocationsets","deprecated":false},{"title":"/locations/charging-location-sets","summary":"Create charging location set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/charging-location-sets/createcharginglocationset","deprecated":false},{"title":"/locations/charging-location-sets/{id}","summary":"Get charging location set","prefix":{"name":"get","color":"get"},"badges":[],"link":"/charging-location-sets/getcharginglocationset","deprecated":false},{"title":"/locations/charging-location-sets/{id}","summary":"Upsert charging location set","prefix":{"name":"put","color":"put"},"badges":[],"link":"/charging-location-sets/upsertcharginglocationset","deprecated":false},{"title":"/locations/charging-location-sets/{id}","summary":"Delete charging location set","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/charging-location-sets/deletecharginglocationset","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$","example":"cb1fb12c-0abc-413c-a69d-63c62566685f"}},"components/schemas/BusinessId":{"id":"components/schemas/BusinessId","kind":"json-schema","title":"BusinessId","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,512}$","example":"cb1fb12c-0abc-413c-a69d-63c62566685f"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information on the physical address of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]}]}]}],"type":"object","properties":{"address_line":{"type":"string","example":"Voordries 41b"},"city":{"type":"string","example":"Oosterzele"},"zip_code":{"type":"string","example":"9860"},"country_code":{"$ref":"#/components/schemas/CountryCode"}}}},"components/schemas/Break":{"id":"components/schemas/Break","kind":"json-schema","title":"Break","data":{"type":"object","properties":{"at":{"description":"The planned time of the break","type":"string","format":"date-time","example":"2024-12-01T11:15:30Z"},"duration":{"description":"The duration of the break","type":"string","format":"duration","example":"PT45M"}},"required":["at","duration"]}},"components/schemas/Capacity":{"id":"components/schemas/Capacity","kind":"json-schema","title":"Capacity","data":{"type":"object","description":"Dimensional value of a capacity.","properties":{"type":{"type":"string","enum":["volume","weight","loadingMeters","capacity1","capacity2","capacity3","capacity4","capacity5"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Characterization of a capacity, representing the dimension in which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Capacity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is expressed."},"children":[]}]}]}],"default":"volume","example":"weight"},"value":{"type":"number","format":"double","example":20.02}},"required":["type","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/Cursors":{"id":"components/schemas/Cursors","kind":"json-schema","title":"Cursors","data":{"type":"object","properties":{"self":{"type":"string","description":"The cursor for this page. Not present when the result contains no data.","example":"c2VsZl9fcGFnZQ"},"prev":{"type":"string","description":"The cursor for the previous page. Not present when fetching data for the first page.","example":"cHJldmlvdXNfX3BhZ2U"},"next":{"type":"string","description":"The cursor for the next page. Not present when fetching data for the last page.","example":"bmV4dF9fcGFnZQ"}}}},"components/schemas/CursorsWithOnlyNext":{"id":"components/schemas/CursorsWithOnlyNext","kind":"json-schema","title":"CursorsWithOnlyNext","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor that only supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cursor navigation."},"children":[]}]}]}],"properties":{"next":{"type":"string","description":"The cursor for the next page. Not present when fetching data for the last page.","example":"bmV4dF9fcGFnZQ"}}}},"components/schemas/CustomData":{"id":"components/schemas/CustomData","kind":"json-schema","title":"CustomData","data":{"description":"Custom data is an extendable hashmap of key-value pairs.","additionalProperties":{"type":"string"},"example":{"shop_manager":"John Smith"}}},"components/schemas/Charge":{"id":"components/schemas/Charge","kind":"json-schema","title":"Charge","data":{"type":"object","properties":{"timings":{"$ref":"#/components/schemas/ChargeTimings"}},"required":["timings"]}},"components/schemas/ChargeTimings":{"id":"components/schemas/ChargeTimings","kind":"json-schema","title":"ChargeTimings","data":{"type":"object","properties":{"arrival_at":{"description":"The planned time of arrival at the charging location","type":"string","format":"date-time","example":"2024-12-01T10:30:00Z"},"charge_time":{"description":"This is the charge time of the EV on the location.\n","type":"string","format":"duration","example":"PT15M"},"wait_time":{"description":"This is the wait time on the charging location.","type":"string","format":"duration","example":"PT30M"},"departure_at":{"description":"The planned time of departure at the charging location","type":"string","format":"date-time","example":"2024-12-01T11:15:00Z"}},"required":["arrival_at","charge_time","wait_time","departure_at"]}},"components/schemas/Delivery":{"id":"components/schemas/Delivery","kind":"json-schema","title":"Delivery","data":{"description":"A delivery order","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformation"},"timings":{"$ref":"#/components/schemas/OrderTimings"}},"required":["order","timings"]}},"components/schemas/Employee":{"id":"components/schemas/Employee","kind":"json-schema","title":"Employee","data":{"description":"Person driving the transport resource","properties":{"business_id":{"description":"Identifier of the employee","type":"string","example":"EMP-18"},"name":{"description":"Name of the employee","type":"string","example":"Patrick Simmons"},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["business_id","name"]}},"components/schemas/GeoPoint":{"id":"components/schemas/GeoPoint","kind":"json-schema","title":"GeoPoint","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geodetic coordinates of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]}]}]}],"type":"object","properties":{"latitude":{"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":"The latitude value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in degrees (WGS84/EPSG:4326) from south to north."},"children":[]}]}]}],"maximum":90,"minimum":-90,"example":50.9514048},"longitude":{"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":"The longitude value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in degrees (WGS84/EPSG:4326) from west to east."},"children":[]}]}]}],"maximum":180,"minimum":-180,"example":3.8067878}},"required":["latitude","longitude"]}},"components/schemas/GeoPointWithResolvedInfo":{"id":"components/schemas/GeoPointWithResolvedInfo","kind":"json-schema","title":"GeoPointWithResolvedInfo","data":{"properties":{"latitude":{"type":"number","format":"double","example":50.9514048,"minimum":-90,"maximum":90},"longitude":{"type":"number","format":"double","example":3.8067878,"minimum":-180,"maximum":180},"resolved":{"readOnly":true,"type":"object","description":"Geocoding resolution information.","properties":{"geocoded":{"type":"boolean","description":"Indicates if the provided address was geocoded or not.\nGeocoding only happens when the provided address does not yet have a geo-point.\n","example":true},"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address that matches the resolved geo-point. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geocoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Voordries 41, 9860 Oosterzele"},"precision":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geocoding confidence score from 0-10."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 indicates 100% confidence that the coordinates match the provided address. 0 indicates no confidence in the match."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geocoded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minimum":0,"maximum":10,"example":9}}}},"required":["latitude","longitude"]}},"components/schemas/GetPlanningsResponse":{"id":"components/schemas/GetPlanningsResponse","kind":"json-schema","title":"GetPlanningsResponse","data":{"type":"object","properties":{"plannings":{"type":"array","items":{"$ref":"#/components/schemas/PlanningSummary"}},"cursor":{"$ref":"#/components/schemas/Cursors"}},"required":["plannings","cursor"]}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A physical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at which an activity occurs."},"children":[]}]}]}],"type":"object","properties":{"business_id":{"description":"Unique identifier of the location","type":"string","example":"LOC_001"},"name":{"type":"string","example":"Conundra (Oosterzele)"},"type":{"$ref":"#/components/schemas/LocationType"},"geo_point":{"$ref":"#/components/schemas/GeoPoint"},"address":{"$ref":"#/components/schemas/Address"}},"required":["business_id","type","geo_point"]}},"components/schemas/LocationType":{"id":"components/schemas/LocationType","kind":"json-schema","title":"LocationType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"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":"CAUTION: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RouteBoundary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This could change in the future."},"children":[]}]}]}],"type":"string","enum":["DEPOT","CUSTOMER"],"example":"CUSTOMER"}},"components/schemas/OrderInformation":{"id":"components/schemas/OrderInformation","kind":"json-schema","title":"OrderInformation","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed information of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}],"type":"object","properties":{"business_id":{"type":"string","description":"Unique identifier of the order","example":"O_554"},"description":{"type":"string","example":"Order 554"},"capacities":{"type":"array","minItems":0,"maxItems":8,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Capacity"}},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["business_id","capacities","custom_data"]}},"components/schemas/OrderTimings":{"id":"components/schemas/OrderTimings","kind":"json-schema","title":"OrderTimings","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains summary values of the timings of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Order"},"children":[]}]}]}],"properties":{"arrival_at":{"description":"The planned time of arrival at the order","type":"string","format":"date-time","example":"2024-12-01T10:30:00Z"},"earliest_arrival_at":{"description":"The planned time of earliest arrival","type":"string","format":"date-time","example":"2024-12-01T10:00:00Z"},"latest_arrival_at":{"description":"The planned time of latest arrival","type":"string","format":"date-time","example":"2024-12-01T12:00:00Z"},"service_time":{"description":"The summation of the service time and extra time on arrival and, for the first order, also the location stop.","type":"string","format":"duration","example":"PT15M"},"wait_time":{"description":"The wait time at the order","type":"string","format":"duration","example":"PT30M"},"departure_at":{"description":"The planned time of departure at the order","type":"string","format":"date-time","example":"2024-12-01T11:15:00Z"}},"required":["arrival_at","service_time","wait_time","departure_at"]}},"components/schemas/Pickup":{"id":"components/schemas/Pickup","kind":"json-schema","title":"Pickup","data":{"description":"A pickup order","type":"object","properties":{"order":{"$ref":"#/components/schemas/OrderInformation"},"timings":{"$ref":"#/components/schemas/OrderTimings"}},"required":["order","timings"]}},"components/schemas/PlanningSummary":{"id":"components/schemas/PlanningSummary","kind":"json-schema","title":"PlanningSummary","data":{"type":"object","properties":{"id":{"description":"The identifier for this planning","type":"string","example":"86b54c9d-21d7-4b37-af3d-25f03886153b"},"created_at":{"description":"Timestamp defining when the planning was created","type":"string","format":"date-time","example":"2024-11-30T08:15:00Z"},"released_at":{"description":"Timestamp defining when the planning has been released","type":"string","format":"date-time","example":"2024-11-30T10:00:00Z"},"name":{"description":"The name of the planning","type":"string","example":"Operational Planning"},"labels":{"description":"The labels added to the planning","type":"array","items":{"type":"string"},"example":["operational","DEMO","label-xyz"]}},"required":["id","created_at"]}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"type":"object","properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type.  When dereferenced,\nit SHOULD provide human-readable documentation for the problem type\n(e.g., using HTML).\n","example":"https://developer.conundra.eu/developer-portal/problem/#constraint-violation"},"title":{"type":"string","example":"Bad Request","description":"A short, summary of the problem type. Written in english and readable\nfor engineers (usually not suited for non technical stakeholders and\nnot localized)\n"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence\nof the problem.\n","minimum":100,"maximum":599,"example":400},"detail":{"type":"string","description":"A human readable explanation specific to this occurrence of the\nproblem.\n","example":"Bad request. See violations for more details."},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}}},"required":["type","title","status","detail"]}},"components/schemas/Release":{"id":"components/schemas/Release","kind":"json-schema","title":"Release","data":{"type":"object","properties":{"release_metadata":{"$ref":"#/components/schemas/ReleaseMetadata"},"routes":{"type":"array","items":{"$ref":"#/components/schemas/Route"}}},"required":["release_metadata","routes"]}},"components/schemas/ReleaseMetadata":{"id":"components/schemas/ReleaseMetadata","kind":"json-schema","title":"ReleaseMetadata","data":{"type":"object","properties":{"planning_id":{"description":"The identifier of the planning that this release belongs to","type":"string","example":"86b54c9d-21d7-4b37-af3d-25f03886153b"},"released_at":{"description":"Timestamp defining when the planning has been released","type":"string","format":"date-time","example":"2024-11-30T10:00:00Z"}},"required":["planning_id","released_at"]}},"components/schemas/Vehicle":{"id":"components/schemas/Vehicle","kind":"json-schema","title":"Vehicle","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combination of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and their assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transport Resources"},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the resource combination","example":"5a4e8c43-80c0-4d5b-8f7e-32ec94f25d79"},"employee":{"$ref":"#/components/schemas/Employee"},"transport_resources":{"type":"array","items":{"$ref":"#/components/schemas/TransportResource"}}},"required":["id","employee","transport_resources"]}},"components/schemas/Route":{"id":"components/schemas/Route","kind":"json-schema","title":"Route","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the route","example":"d2c6013e-9194-46ac-a44c-855abf1176ca"},"resource_combination":{"$ref":"#/components/schemas/Vehicle","description":"Deprecated property. Please use the vehicle property which contains the same data."},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"start":{"$ref":"#/components/schemas/RouteBoundary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAUTION: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT"},"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 could change in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The route "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is logically separate from the first stop, even when they share the same physical location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service time defined on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the route is not the same as the service time defined on the route stops."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This service time indicates the time to start a route, not the time for executing the first stop."},"children":[]}]}]}]},"end":{"$ref":"#/components/schemas/RouteBoundary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAUTION: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT"},"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 could change in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The route "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is logically separate from the last stop, even when they share the same physical location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service time defined on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the route is not the same as the service time defined on the route stops."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This service time indicates the time to end a route, not the time for executing the last stop."},"children":[]}]}]}]},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/Break"}},"trips":{"type":"array","items":{"$ref":"#/components/schemas/Trip"}}},"required":["id","resource_combination","vehicle","start","end"]}},"components/schemas/RouteBoundary":{"id":"components/schemas/RouteBoundary","kind":"json-schema","title":"RouteBoundary","data":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/Location"},"timings":{"$ref":"#/components/schemas/RouteBoundaryTimings"}},"required":["location","timings"]}},"components/schemas/RouteBoundaryTimings":{"id":"components/schemas/RouteBoundaryTimings","kind":"json-schema","title":"RouteBoundaryTimings","data":{"description":"Contains summary values of the timings for the start or the end of a route.","properties":{"arrival_at":{"description":"The planned time of arrival at the start / end of the route","type":"string","format":"date-time","example":"2024-12-01T10:30:00Z"},"service_time":{"description":"The planned service time at the start / end of the route","type":"string","format":"duration","example":"PT45M"},"departure_at":{"description":"The planned time of departure at the start / end of the route","type":"string","format":"date-time","example":"2024-12-01T11:15:00Z"}},"required":["arrival_at","service_time","departure_at"]}},"components/schemas/Stop":{"id":"components/schemas/Stop","kind":"json-schema","title":"Stop","data":{"type":"object","properties":{"location":{"$ref":"#/components/schemas/Location"},"deliveries":{"description":"The deliveries at this stop are in the sequence they are executed. \nFor depots we assume the deliveries are executed LIFO.\n","type":"array","minItems":0,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Delivery"}},"pickups":{"description":"The pickups at this stop are in the sequence they are executed. \nFor depots we assume the pickups are executed LIFO.\n","type":"array","minItems":0,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Pickup"}},"charges":{"type":"array","description":"The charge sessions for an EV at this stop are in the sequence they are executed.\n","minItems":0,"uniqueItems":true,"items":{"$ref":"#/components/schemas/Charge"}},"timings":{"$ref":"#/components/schemas/StopTimings"}},"required":["location","deliveries","pickups","charges","timings"]}},"components/schemas/StopTimings":{"id":"components/schemas/StopTimings","kind":"json-schema","title":"StopTimings","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains summary values of the timings at a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]}],"properties":{"arrival_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The planned time of arrival at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]}]}]}],"type":"string","format":"date-time","example":"2024-12-01T10:30:00Z"},"service_time":{"description":"This is the summation of the individual order service times.","type":"string","format":"duration","example":"PT15M"},"wait_time":{"description":"This is the summation of the individual order and charging wait times.","type":"string","format":"duration","example":"PT30M"},"charge_time":{"description":"This is the summation of the individual charge times of the EV.\n","type":"string","format":"duration","example":"PT30M"},"departure_at":{"description":"The planned time of departure at the stop","type":"string","format":"date-time","example":"2024-12-01T11:15:00Z"}},"required":["arrival_at","service_time","wait_time","charge_time","departure_at"]}},"components/schemas/TransportResource":{"id":"components/schemas/TransportResource","kind":"json-schema","title":"TransportResource","data":{"type":"object","properties":{"business_id":{"description":"Unique identifier of the transport resource","type":"string","example":"TR-14"},"license_plate":{"description":"License plate of the transport resource","type":"string","example":"2-QBD-124"},"custom_data":{"$ref":"#/components/schemas/CustomData"}},"required":["business_id"]}},"components/schemas/Trip":{"id":"components/schemas/Trip","kind":"json-schema","title":"Trip","data":{"type":"object","properties":{"stops":{"type":"array","items":{"$ref":"#/components/schemas/Stop"}}},"required":["stops"]}},"components/schemas/Violation":{"id":"components/schemas/Violation","kind":"json-schema","title":"Violation","data":{"type":"object","properties":{"field":{"type":"string","description":"A reference to the field in the request that triggered this violation.","example":"limit"},"message":{"type":"string","description":"A message explaining the violation in the referenced field.","example":"Limit must be strictly positive."}},"required":["message"]}},"components/schemas/CursorPageLocationWorkloadLevellingSets":{"id":"components/schemas/CursorPageLocationWorkloadLevellingSets","kind":"json-schema","title":"CursorPageLocationWorkloadLevellingSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LocationWorkloadLevellingSetResponse"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location Workload Levelling Set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursor":{"$ref":"#/components/schemas/Cursors"}},"required":["data","cursor"]}},"components/schemas/LocationWorkloadLevellingSet":{"id":"components/schemas/LocationWorkloadLevellingSet","kind":"json-schema","title":"LocationWorkloadLevellingSet","data":{"type":"object","properties":{"business_id":{"description":"The identifier for this location workload levelling set","$ref":"#/components/schemas/BusinessId","readOnly":true},"name":{"description":"The name of the location workload levelling set","type":"string","example":"Weekday"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/LocationWorkloadLevellingSetting"}}}}},"components/schemas/LocationWorkloadLevellingSetResponse":{"id":"components/schemas/LocationWorkloadLevellingSetResponse","kind":"json-schema","title":"LocationWorkloadLevellingSetResponse","data":{"allOf":[{"$ref":"#/components/schemas/LocationWorkloadLevellingSet"},{"type":"object","properties":{"etag":{"$ref":"#/components/schemas/Etag"}}}]}},"components/schemas/LocationWorkloadLevellingSetting":{"id":"components/schemas/LocationWorkloadLevellingSetting","kind":"json-schema","title":"LocationWorkloadLevellingSetting","data":{"type":"object","properties":{"location_business_ids":{"description":"List of business IDs of locations this setting applies to","type":"array","items":{"type":"string"},"example":["LOC_001","LOC_002"]},"loading_zones":{"description":"List of loading zones available at the locations","type":"array","items":{"$ref":"#/components/schemas/LoadingZone"}},"minimum_buffer_duration":{"description":"The minimum buffer duration between vehicles using the same loading zone. Must be an ISO-8601 compliant Duration string.","type":"string","format":"ISO-8601","example":"PT30M"}}}},"components/schemas/LoadingZone":{"id":"components/schemas/LoadingZone","kind":"json-schema","title":"LoadingZone","data":{"type":"object","properties":{"cost":{"description":"The cost associated with using this loading zone","type":"number","format":"double","example":10}}}},"components/schemas/Etag":{"id":"components/schemas/Etag","kind":"json-schema","title":"Etag","data":{"type":"string","example":"W/\"1\""}},"components/schemas/CursorPageOrderOrderRestrictionSets":{"id":"components/schemas/CursorPageOrderOrderRestrictionSets","kind":"json-schema","title":"CursorPageOrderOrderRestrictionSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderOrderRestrictionSetListSummary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of order-order restriction sets matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/OrderOrderRestrictionSetListSummary":{"id":"components/schemas/OrderOrderRestrictionSetListSummary","kind":"json-schema","title":"OrderOrderRestrictionSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-order restriction set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the order-order restriction set","type":"string","example":"Ambient goods not with chilled goods"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/OrderOrderRestrictionSet":{"id":"components/schemas/OrderOrderRestrictionSet","kind":"json-schema","title":"OrderOrderRestrictionSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-order restriction set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the order-order restriction set","type":"string","minLength":1,"maxLength":250,"example":"Ambient goods not with chilled goods"},"restrictions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrderOrderRestriction"},"description":"List of order-order restrictions in this set"}},"required":["name","restrictions"]}},"components/schemas/OrderOrderRestriction":{"id":"components/schemas/OrderOrderRestriction","kind":"json-schema","title":"OrderOrderRestriction","data":{"type":"object","properties":{"order_label_1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First order label (DEPRECATED — use restriction.subject.label)"},"children":[]}]}]}],"deprecated":true,"minLength":1,"maxLength":250,"example":"ambient"},"type":{"$ref":"#/components/schemas/OrderOrderRestrictionType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restriction type (DEPRECATED — use restriction.type)"},"children":[]}]}]}],"deprecated":true},"order_label_2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second order label (DEPRECATED — use restriction.target.label)"},"children":[]}]}]}],"deprecated":true,"minLength":1,"maxLength":250,"example":"chilled"},"vehicle_label":{"oneOf":[{"type":"string","minLength":1,"maxLength":250},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vehicle label (DEPRECATED — use conditions.vehicles)"},"children":[]}]}]}],"deprecated":true,"example":"cooler truck"},"restriction":{"$ref":"#/components/schemas/OrderOrderRestrictionRestriction"},"conditions":{"$ref":"#/components/schemas/OrderOrderRestrictionConditions"}}}},"components/schemas/OrderOrderRestrictionRestriction":{"id":"components/schemas/OrderOrderRestrictionRestriction","kind":"json-schema","title":"OrderOrderRestrictionRestriction","data":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/OrderLabelCondition"},"type":{"$ref":"#/components/schemas/OrderOrderRestrictionType"},"target":{"$ref":"#/components/schemas/OrderLabelCondition"}},"required":["subject","type","target"]}},"components/schemas/OrderOrderRestrictionConditions":{"id":"components/schemas/OrderOrderRestrictionConditions","kind":"json-schema","title":"OrderOrderRestrictionConditions","data":{"type":"object","properties":{"vehicles":{"$ref":"#/components/schemas/VehicleCondition"}},"required":["vehicles"]}},"components/schemas/LabelCondition":{"id":"components/schemas/LabelCondition","kind":"json-schema","title":"LabelCondition","data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":250,"example":"frozen"},"operator":{"type":"string","enum":["INCLUDING","EXCLUDING"],"example":"INCLUDING"}},"required":["label","operator"]}},"components/schemas/OrderLabelCondition":{"id":"components/schemas/OrderLabelCondition","kind":"json-schema","title":"OrderLabelCondition","data":{"allOf":[{"$ref":"#/components/schemas/LabelCondition"}]}},"components/schemas/DepotLabelCondition":{"id":"components/schemas/DepotLabelCondition","kind":"json-schema","title":"DepotLabelCondition","data":{"allOf":[{"$ref":"#/components/schemas/LabelCondition"}]}},"components/schemas/VehicleCondition":{"id":"components/schemas/VehicleCondition","kind":"json-schema","title":"VehicleCondition","data":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":250,"example":"cooler truck"},"operator":{"type":"string","enum":["ALL","INCLUDING","EXCLUDING"],"example":"ALL"}},"required":["operator"]}},"components/schemas/OrderOrderRestrictionType":{"id":"components/schemas/OrderOrderRestrictionType","kind":"json-schema","title":"OrderOrderRestrictionType","data":{"type":"string","enum":["NOT_TOGETHER_IN_VEHICLE_WITH","NOT_LOADED_OR_UNLOADED_WHILE_VEHICLE_CONTAINS","NOT_AFTER","NOT_IMMEDIATELY_AFTER","NOT_BEFORE","NOT_LOADED_WHILE_VEHICLE_CONTAINS","NOT_UNLOADED_WHILE_VEHICLE_CONTAINS"],"description":"Type of restriction","example":"NOT_TOGETHER_IN_VEHICLE_WITH"}},"components/schemas/CursorPageOrderDepotRestrictionSets":{"id":"components/schemas/CursorPageOrderDepotRestrictionSets","kind":"json-schema","title":"CursorPageOrderDepotRestrictionSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderDepotRestrictionSetListSummary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of order-depot restriction sets matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/OrderDepotRestrictionSetListSummary":{"id":"components/schemas/OrderDepotRestrictionSetListSummary","kind":"json-schema","title":"OrderDepotRestrictionSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-depot restriction set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the order-depot restriction set","type":"string","example":"Operationeel"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/OrderDepotRestrictionSet":{"id":"components/schemas/OrderDepotRestrictionSet","kind":"json-schema","title":"OrderDepotRestrictionSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-depot restriction set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the order-depot restriction set","type":"string","minLength":1,"maxLength":250,"example":"Operationeel"},"restrictions":{"type":"array","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/OrderDepotRestriction"},"description":"List of order-depot restrictions in this set"}},"required":["name","restrictions"]}},"components/schemas/OrderDepotRestriction":{"id":"components/schemas/OrderDepotRestriction","kind":"json-schema","title":"OrderDepotRestriction","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderDepotRestrictionType"},"order":{"$ref":"#/components/schemas/OrderLabelCondition"},"depot":{"$ref":"#/components/schemas/DepotLabelCondition"}},"required":["type","order","depot"]}},"components/schemas/OrderDepotRestrictionType":{"id":"components/schemas/OrderDepotRestrictionType","kind":"json-schema","title":"OrderDepotRestrictionType","data":{"type":"string","enum":["ORDER_REQUIRES_DEPOT","DEPOT_REQUIRES_ORDER","FORBIDDEN_COMBINATION"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of order-depot restriction:"},"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":"code","inline":true,"attributes":{"content":"ORDER_REQUIRES_DEPOT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Orders with the given label can only be (un)loaded at depots with the given label"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEPOT_REQUIRES_ORDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - At depots with the given label only orders with the given label can be (un)loaded"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORBIDDEN_COMBINATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Orders with the given label cannot be (un)loaded at depots with the given label"},"children":[]}]}]}]}],"example":"ORDER_REQUIRES_DEPOT"}},"components/schemas/CursorPageOrderVehiclePreferenceSets":{"id":"components/schemas/CursorPageOrderVehiclePreferenceSets","kind":"json-schema","title":"CursorPageOrderVehiclePreferenceSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderVehiclePreferenceSetListSummary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of order-vehicle preference sets matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/OrderVehiclePreferenceSetListSummary":{"id":"components/schemas/OrderVehiclePreferenceSetListSummary","kind":"json-schema","title":"OrderVehiclePreferenceSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-vehicle preference set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the order-vehicle preference set","type":"string","example":"Heavy goods require large trucks"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/OrderVehiclePreferenceSet":{"id":"components/schemas/OrderVehiclePreferenceSet","kind":"json-schema","title":"OrderVehiclePreferenceSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the order-vehicle preference set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the order-vehicle preference set","type":"string","minLength":1,"maxLength":250,"example":"Heavy goods require large trucks"},"order_vehicle_preferences":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/OrderVehiclePreference"},"description":"List of order-vehicle preferences in this set"}},"required":["name","order_vehicle_preferences"]}},"components/schemas/OrderVehiclePreference":{"id":"components/schemas/OrderVehiclePreference","kind":"json-schema","title":"OrderVehiclePreference","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 preference rule that defines a soft constraint between orders and vehicles based on their labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When violated during planning, the specified fine (penalty cost) is applied."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports two formats: structured (order/vehicle objects) or deprecated flat (order_label/vehicle_label strings)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When both are present, the structured format takes precedence."},"children":[]}]}]}],"properties":{"order_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Label that identifies matching orders."},"children":[]}]}]}],"minLength":1,"maxLength":250,"example":"fragile"},"vehicle_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Label that identifies matching vehicles."},"children":[]}]}]}],"minLength":1,"maxLength":250,"example":"careful-truck"},"order":{"$ref":"#/components/schemas/OrderVehiclePreferenceLabelCondition"},"vehicle":{"$ref":"#/components/schemas/OrderVehiclePreferenceLabelCondition"},"type":{"$ref":"#/components/schemas/OrderVehiclePreferenceType"},"fine":{"type":"number","format":"double","description":"Penalty cost applied when this preference is violated during planning. Higher values make violations less likely.","exclusiveMinimum":0,"maximum":1000000,"example":42.5}},"required":["type","fine"]}},"components/schemas/OrderVehiclePreferenceLabelCondition":{"id":"components/schemas/OrderVehiclePreferenceLabelCondition","kind":"json-schema","title":"OrderVehiclePreferenceLabelCondition","data":{"type":"object","description":"A label condition for order-vehicle preferences. Only the INCLUDING operator is supported at this point.","properties":{"label":{"type":"string","minLength":1,"maxLength":250,"example":"fragile"},"operator":{"type":"string","enum":["INCLUDING"],"example":"INCLUDING"}},"required":["label","operator"]}},"components/schemas/OrderVehiclePreferenceType":{"id":"components/schemas/OrderVehiclePreferenceType","kind":"json-schema","title":"OrderVehiclePreferenceType","data":{"type":"string","enum":["ORDER_REQUIRES_VEHICLE","FORBIDDEN_COMBINATION","VEHICLE_REQUIRES_ORDER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the relationship between the order label and vehicle label:"},"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":"code","inline":true,"attributes":{"content":"FORBIDDEN_COMBINATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Orders with the specified label are penalized when assigned to vehicles with the specified label."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORDER_REQUIRES_VEHICLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Orders with the specified label require vehicles with the specified label; a fine is applied if assigned to a different vehicle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VEHICLE_REQUIRES_ORDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Vehicles with the specified label require orders with the specified label; a fine is applied if assigned different orders."},"children":[]}]}]}]}],"example":"ORDER_REQUIRES_VEHICLE"}},"components/schemas/CursorPageBreakRuleSets":{"id":"components/schemas/CursorPageBreakRuleSets","kind":"json-schema","title":"CursorPageBreakRuleSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BreakRuleSetPageItem"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Break Rule Set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/BreakRuleSet":{"id":"components/schemas/BreakRuleSet","kind":"json-schema","title":"BreakRuleSet","data":{"allOf":[{"$ref":"#/components/schemas/BreakRuleSetUpsertRequest"},{"type":"object","properties":{"id":{"description":"The identifier for this break rule set","$ref":"#/components/schemas/Id"}}}]}},"components/schemas/BreakRuleSetPageItem":{"id":"components/schemas/BreakRuleSetPageItem","kind":"json-schema","title":"BreakRuleSetPageItem","data":{"allOf":[{"$ref":"#/components/schemas/BreakRuleSet"},{"type":"object","properties":{"etag":{"$ref":"#/components/schemas/Etag"}}}]}},"components/schemas/BreakRuleSetUpsertRequest":{"id":"components/schemas/BreakRuleSetUpsertRequest","kind":"json-schema","title":"BreakRuleSetUpsertRequest","data":{"type":"object","properties":{"name":{"description":"The name of the break rule set","type":"string","minLength":1,"maxLength":250,"example":"Legal breaks for Belgium"},"break_rule_groups":{"description":"List of all break rule groups within a set","type":"array","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/BreakRuleGroup"}}},"required":["name","break_rule_groups"]}},"components/schemas/BreakRuleGroup":{"id":"components/schemas/BreakRuleGroup","kind":"json-schema","title":"BreakRuleGroup","data":{"type":"object","properties":{"name":{"description":"The name of the break rule group","type":"string","minLength":1,"maxLength":250,"example":"Heavy trucks"},"break_rules":{"description":"List of break rules","type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/BreakRule"}}},"required":["name","break_rules"]}},"components/schemas/BreakRule":{"id":"components/schemas/BreakRule","kind":"json-schema","title":"BreakRule","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"MAX_WORK_TIME_BETWEEN_BREAKS":"#/components/schemas/MaxWorkTimeBetweenBreaks","MAX_DRIVE_TIME_BETWEEN_BREAKS":"#/components/schemas/MaxDriveTimeBetweenBreaks"}},"properties":{"type":{"type":"string"}},"required":["type"]}},"components/schemas/MaxWorkTimeBetweenBreaks":{"id":"components/schemas/MaxWorkTimeBetweenBreaks","kind":"json-schema","title":"MaxWorkTimeBetweenBreaks","data":{"allOf":[{"$ref":"#/components/schemas/BreakRule"},{"type":"object","properties":{"max_work_time_between_breaks":{"type":"string","format":"duration","description":"Maximum work time between breaks in ISO-8601 duration format. Must be non-negative and not exceed 7 days.","example":"PT4H30M"},"break_duration":{"type":"string","format":"duration","description":"Duration of the break in ISO-8601 duration format. Must be non-negative and not exceed 7 days.","example":"PT45M"}},"required":["max_work_time_between_breaks","break_duration"]}]}},"components/schemas/MaxDriveTimeBetweenBreaks":{"id":"components/schemas/MaxDriveTimeBetweenBreaks","kind":"json-schema","title":"MaxDriveTimeBetweenBreaks","data":{"allOf":[{"$ref":"#/components/schemas/BreakRule"},{"type":"object","properties":{"max_drive_time_between_breaks":{"type":"string","format":"duration","description":"Maximum drive time between breaks in ISO-8601 duration format. Must be non-negative and not exceed 7 days.","example":"PT4H30M"},"break_duration":{"type":"string","format":"duration","description":"Duration of the break in ISO-8601 duration format. Must be non-negative and not exceed 7 days.","example":"PT45M"}},"required":["max_drive_time_between_breaks","break_duration"]}]}},"components/schemas/CursorPageVehicleStopRuleSets":{"id":"components/schemas/CursorPageVehicleStopRuleSets","kind":"json-schema","title":"CursorPageVehicleStopRuleSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VehicleStopRuleSetListSummary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of vehicle stop rule sets matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/VehicleStopRuleSetListSummary":{"id":"components/schemas/VehicleStopRuleSetListSummary","kind":"json-schema","title":"VehicleStopRuleSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the vehicle stop rule set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the vehicle stop rule set","type":"string","example":"Urban delivery stop limits"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/VehicleStopRuleSet":{"id":"components/schemas/VehicleStopRuleSet","kind":"json-schema","title":"VehicleStopRuleSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the vehicle stop rule set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the vehicle stop rule set","type":"string","minLength":1,"maxLength":250,"example":"Urban delivery stop limits"},"rules":{"description":"List of vehicle stop rules. When multiple rules match for a single vehicle, all their distinct effects are applied.\nIf two matching rules set the same effect (e.g., both set a stop cost), only the value from the first matching rule is used for that effect.\n","type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/VehicleStopRule"}},"excluded_stop_locations":{"description":"Locations to exclude from stop counting. Applies to all rules in this set.","type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/VehicleStopRuleSetLocationLabelCondition"}}},"required":["name","rules"]}},"components/schemas/VehicleStopRule":{"id":"components/schemas/VehicleStopRule","kind":"json-schema","title":"VehicleStopRule","data":{"type":"object","properties":{"name":{"description":"The name of the rule","type":"string","minLength":1,"maxLength":250,"example":"Sprinter"},"conditions":{"description":"Conditions to match vehicles. A rule matches if any of the conditions matches. At least one condition is required. Use ALL to match all vehicles. Combining ALL with other conditions is not allowed.","type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/VehicleStopRuleCondition"}},"effects":{"$ref":"#/components/schemas/VehicleStopRuleEffects"}},"required":["name","conditions","effects"]}},"components/schemas/VehicleStopRuleCondition":{"id":"components/schemas/VehicleStopRuleCondition","kind":"json-schema","title":"VehicleStopRuleCondition","data":{"type":"object","properties":{"label":{"description":"A vehicle label to match. Required for INCLUDING and EXCLUDING operators, must not be set for ALL.","type":"string","minLength":1,"maxLength":250,"example":"sprinter"},"operator":{"$ref":"#/components/schemas/VehicleStopRuleConditionOperator"}},"required":["operator"]}},"components/schemas/VehicleStopRuleConditionOperator":{"id":"components/schemas/VehicleStopRuleConditionOperator","kind":"json-schema","title":"VehicleStopRuleConditionOperator","data":{"type":"string","enum":["ALL","INCLUDING","EXCLUDING"]}},"components/schemas/VehicleStopRuleSetLocationLabelCondition":{"id":"components/schemas/VehicleStopRuleSetLocationLabelCondition","kind":"json-schema","title":"VehicleStopRuleSetLocationLabelCondition","data":{"type":"object","properties":{"label":{"description":"A location label to match","type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$","example":"warehouse"},"operator":{"$ref":"#/components/schemas/VehicleStopRuleSetLocationLabelOperator"}},"required":["label","operator"]}},"components/schemas/VehicleStopRuleSetLocationLabelOperator":{"id":"components/schemas/VehicleStopRuleSetLocationLabelOperator","kind":"json-schema","title":"VehicleStopRuleSetLocationLabelOperator","data":{"type":"string","enum":["INCLUDING","EXCLUDING"]}},"components/schemas/VehicleStopRuleEffects":{"id":"components/schemas/VehicleStopRuleEffects","kind":"json-schema","title":"VehicleStopRuleEffects","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Effects to apply when the rule matches. At least one of max_stops or cost_per_stop must be specified."},"children":[]}]}]}],"type":"object","properties":{"max_stops":{"$ref":"#/components/schemas/VehicleStopRuleMaxStops"},"cost_per_stop":{"description":"Cost added per stop for matching vehicles","type":"number","format":"double","minimum":0,"example":5}}}},"components/schemas/VehicleStopRuleMaxStops":{"id":"components/schemas/VehicleStopRuleMaxStops","kind":"json-schema","title":"VehicleStopRuleMaxStops","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of stops. At least one of per_route or per_trip must be specified."},"children":[]}]}]}],"type":"object","properties":{"per_route":{"description":"Maximum number of stops per route","type":"integer","minimum":1,"example":20},"per_trip":{"description":"Maximum number of stops per trip","type":"integer","minimum":1,"example":5}}}},"components/schemas/CursorPageDepotSets":{"id":"components/schemas/CursorPageDepotSets","kind":"json-schema","title":"CursorPageDepotSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DepotSetListSummary"},"description":"The set of results for the current page.\n"},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/DepotSetListSummary":{"id":"components/schemas/DepotSetListSummary","kind":"json-schema","title":"DepotSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the depot set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the depot set","type":"string","example":"Belgian Depots"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/DepotSet":{"id":"components/schemas/DepotSet","kind":"json-schema","title":"DepotSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the depot set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the depot set","type":"string","minLength":1,"maxLength":200,"example":"Belgian Depots"},"depots":{"type":"array","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/Depot"},"description":"List of depots in this set"}},"required":["name","depots"]}},"components/schemas/Depot":{"id":"components/schemas/Depot","kind":"json-schema","title":"Depot","data":{"type":"object","properties":{"id":{"description":"Identifier of a depot unique within the set","$ref":"#/components/schemas/Id"},"name":{"description":"Name of the depot","type":"string","minLength":1,"maxLength":200,"example":"Depot Ghent"},"address":{"$ref":"#/components/schemas/DepotAddress"},"stop_time":{"description":"Stop time at the depot in ISO-8601 duration format","type":"string","format":"duration","example":"PT5M","default":"PT0M"},"labels":{"description":"Labels assigned to this depot, used in features such as order-depot restrictions to target depots with certain labels","type":"array","maxItems":100,"items":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,200}$"}}},"required":["id","name","address"]}},"components/schemas/DepotAddress":{"id":"components/schemas/DepotAddress","kind":"json-schema","title":"DepotAddress","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address information for the depot."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When geo_point is provided, address fields (address_line, city, zip_code, country_code) are optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When geo_point is omitted, address fields must be provided so that the address can be geo-coded."},"children":[]}]}]}],"properties":{"address_line":{"type":"string","minLength":1,"maxLength":500,"example":"Voordries 41","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The part of the address that includes the street name, house number, bus number etc."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"city":{"type":"string","minLength":1,"maxLength":200,"example":"Oosterzele","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City name. Required when omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"zip_code":{"type":"string","minLength":1,"maxLength":20,"example":"9860","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code. Required when omitting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geo_point"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"country_code":{"$ref":"#/components/schemas/CountryCode"},"geo_point":{"$ref":"#/components/schemas/GeoPointWithResolvedInfo"}}}},"components/schemas/CursorPageChargingLocationSets":{"id":"components/schemas/CursorPageChargingLocationSets","kind":"json-schema","title":"CursorPageChargingLocationSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChargingLocationSetListSummary"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Charging Location Set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matching the provided query, limited to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the request."},"children":[]}]}]}]},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/ChargingLocationSetListSummary":{"id":"components/schemas/ChargingLocationSetListSummary","kind":"json-schema","title":"ChargingLocationSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the charging location set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the charging location set","type":"string","example":"Flanders Charging Locations"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/ChargingLocationSet":{"id":"components/schemas/ChargingLocationSet","kind":"json-schema","title":"ChargingLocationSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the charging location set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the charging location set","type":"string","minLength":1,"maxLength":200,"example":"Flanders Charging Locations"},"charging_locations":{"description":"List of charging locations in this set","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/ChargingLocation"}}}}},"components/schemas/ChargingLocation":{"id":"components/schemas/ChargingLocation","kind":"json-schema","title":"ChargingLocation","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the charging location.","$ref":"#/components/schemas/Id"},"charging_stations":{"description":"List of charging stations at this charging location. Currently limited to one.","type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/ChargingStation"}}}}},"components/schemas/ChargingStation":{"id":"components/schemas/ChargingStation","kind":"json-schema","title":"ChargingStation","data":{"type":"object","properties":{"maximum_power":{"description":"The maximum charging power of this charging station in kW.","type":"integer","minimum":1,"example":300}}}},"components/schemas/CursorPageLocationRuleSets":{"id":"components/schemas/CursorPageLocationRuleSets","kind":"json-schema","title":"CursorPageLocationRuleSets","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LocationRuleSetListSummary"},"description":"The set of results for the current page.\n"},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/LocationRuleSetListSummary":{"id":"components/schemas/LocationRuleSetListSummary","kind":"json-schema","title":"LocationRuleSetListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the location rule set.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the location rule set","type":"string","example":"DC stop time rules"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/LocationRuleSet":{"id":"components/schemas/LocationRuleSet","kind":"json-schema","title":"LocationRuleSet","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the location rule set.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the location rule set","type":"string","minLength":1,"maxLength":250,"example":"DC stop time rules"},"location_rules":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has one or more conditions. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has it's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applied when at least one of its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is satisfied."},"children":[]}]}]}],"type":"array","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/LocationRule"}}},"required":["name","location_rules"]}},"components/schemas/LocationRule":{"id":"components/schemas/LocationRule","kind":"json-schema","title":"LocationRule","data":{"type":"object","properties":{"name":{"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location rule"},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":250,"example":"Extra stop time at distribution center"},"conditions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match locations. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches when both the location filter and the previous location filter match. At least one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/LocationRuleCondition"}},"effects":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Effects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply when the rule matches."},"children":[]}]}]}],"$ref":"#/components/schemas/LocationRuleEffects"}},"required":["name","conditions","effects"]}},"components/schemas/LocationRuleCondition":{"id":"components/schemas/LocationRuleCondition","kind":"json-schema","title":"LocationRuleCondition","data":{"type":"object","properties":{"locations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rule will apply when the location labels of the stop match. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"effects"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be applied to stops at these locations."},"children":[]}]}]}],"$ref":"#/components/schemas/LocationFilter"},"previous_locations":{"description":"The rule will apply when the location labels of the stop immediately before match.","$ref":"#/components/schemas/LocationFilter"}},"required":["locations","previous_locations"]}},"components/schemas/LocationFilter":{"id":"components/schemas/LocationFilter","kind":"json-schema","title":"LocationFilter","data":{"type":"object","properties":{"label":{"description":"The locations to target. A location will match when it has a matching label.\nThis field is required for INCLUDING and EXCLUDING operators, must not be set for ALL\n","example":"DISTRIBUTION_CENTER","type":"string","minLength":1,"maxLength":200,"pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$"},"operator":{"$ref":"#/components/schemas/LocationFilterOperator"}},"required":["operator"]}},"components/schemas/LocationFilterOperator":{"id":"components/schemas/LocationFilterOperator","kind":"json-schema","title":"LocationFilterOperator","data":{"type":"string","description":"Filter operator that determines how locations are matched. ALL matches any location, INCLUDING and EXCLUDING requires a label.","example":"INCLUDING","enum":["ALL","INCLUDING","EXCLUDING"]}},"components/schemas/LocationRuleEffects":{"id":"components/schemas/LocationRuleEffects","kind":"json-schema","title":"LocationRuleEffects","data":{"type":"object","description":"Effects to apply to the locations when a location rule matches","properties":{"stop_time":{"description":"Stop time effect to apply","$ref":"#/components/schemas/StopTimeEffect"}},"required":["stop_time"]}},"components/schemas/StopTimeEffect":{"id":"components/schemas/StopTimeEffect","kind":"json-schema","title":"StopTimeEffect","data":{"type":"object","description":[{"$$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":"location rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches, it applies a stop time with two optional components. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"When both factor and extra are provided, the factor is applied first, then the extra duration is added. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"When multiple rules match the same stop, all factors are multiplied together before the sum of all extra durations is added."},"children":[]}]}]}],"properties":{"extra":{"description":"Extra stop time in ISO-8601 duration format. Must be non-negative and not exceed 7 days.\n","type":"string","format":"duration","default":"PT0S","example":"PT15M"},"factor":{"description":"Factor to multiply the stop time by. Must be non-negative.\n","type":"number","format":"double","minimum":0,"default":1,"example":1.5}}}},"components/schemas/CursorPagePlanProfiles":{"id":"components/schemas/CursorPagePlanProfiles","kind":"json-schema","title":"CursorPagePlanProfiles","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlanProfileListSummary"},"description":"The set of results for the current page.\n"},"cursors":{"$ref":"#/components/schemas/CursorsWithOnlyNext"}},"required":["data","cursors"]}},"components/schemas/PlanProfileListSummary":{"id":"components/schemas/PlanProfileListSummary","kind":"json-schema","title":"PlanProfileListSummary","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the plan profile.","$ref":"#/components/schemas/Id"},"name":{"description":"The name of the plan profile","type":"string","example":"Default Profile"},"etag":{"$ref":"#/components/schemas/Etag"}}}},"components/schemas/PlanProfile":{"id":"components/schemas/PlanProfile","kind":"json-schema","title":"PlanProfile","data":{"type":"object","properties":{"id":{"description":"The unique identifier for the plan profile.","$ref":"#/components/schemas/Id","readOnly":true},"name":{"description":"The name of the plan profile","type":"string","minLength":1,"maxLength":200,"example":"Default Profile"},"depot_set_id":{"description":"The unique identifier of the depot set to use for this profile","$ref":"#/components/schemas/Id","example":"belgian-depots"},"charging_location_set_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"style":{"backgroundColor":"orange","color":"white","padding":"4px 8px","borderRadius":"5px","fontSize":"12px","fontWeight":"bold"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Access"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the charging location set to use for this profile"},"children":[]}]}]}],"$ref":"#/components/schemas/Id","example":"flanders-charging-locations"},"break_rule_set_id":{"description":"The unique identifier of the break rule set to use for this profile","$ref":"#/components/schemas/Id","example":"eu-break-rules"},"location_rule_set_id":{"description":"The unique identifier of the location rule set to use for this profile","$ref":"#/components/schemas/Id","example":"link-time-rules"},"vehicle_stop_rule_set_id":{"description":"The unique identifier of the vehicle stop rule set to use for this profile","$ref":"#/components/schemas/Id","example":"urban-delivery-stop-limits"},"order_depot_restriction_set_id":{"description":"The unique identifier of the order-depot restriction set to use for this profile","$ref":"#/components/schemas/Id","example":"operational-restrictions"}},"required":["name"]}},"schema_65":{"kind":"json-schema","data":{"type":"string"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2021-01-01T10:15:30Z"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":100,"example":100},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":1000,"default":100,"example":250},"id":"schema_68"},"schema_69":{"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":[]}]}]}]},"Location":{"type":"string","description":"Location of the created resource"}}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]{1,200}$"},"id":"schema_70"},"schema_71":{"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_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","example":"W/\"24\""},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100,"example":100},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9.~\\-_]+$"},"id":"schema_74"},"schema_75":{"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":[]}]}]}]},"Location":{"type":"string","example":"/settings/location-workload-levelling-sets/86b54c9d-21d7-4b37-af3d-25f03886153b","description":"The URL of the newly created resource"}}},"id":"schema_75"}},"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 and 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/plannings/planning-api","isMockServer":true,"description":"Mock server"},{"url":"https://api.conundra.eu/planning/v1","description":"Production Api"}]},"options":{"codeSamples":{"languages":[]},"hidePropertiesPrefix":true,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"url":"/_mock/apis/plannings/planning-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/plannings/planning-api.json?download"},{"url":"/_bundle/apis/plannings/planning-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"PTV OptiFlow Planning API","description":"The planning API provides information about plannings and their lifecycle. \n\nYou can find out more in our [developer portal](https://developer.conundra.eu/developer-portal/planning/).\n"}},"baseSlug":"/apis/plannings/planning-api","routesMapping":{}}