From 808f34916534b1500219191e41ca206afdba4e5b Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 24 Apr 2024 15:00:01 +0200 Subject: [PATCH 1/4] feat #500 update IRS api spec --- .../Job Api/cancel-batch-order.api.mdx | 66 ----- .../Job Api/cancel-job-by-job-id.api.mdx | 70 ----- .../Job Api/delete-allowed-policy.api.mdx | 46 --- .../Job Api/get-all-aspect-models.api.mdx | 42 --- .../Job Api/get-allowed-policies.api.mdx | 42 --- .../Job Api/get-batch-order.api.mdx | 66 ----- .../Job Api/get-batch.api.mdx | 58 ---- .../Job Api/get-bpn-investigation.api.mdx | 154 ---------- .../Job Api/get-job-for-job-id.api.mdx | 262 ------------------ .../Job Api/get-jobs-by-job-states.api.mdx | 46 --- .../Job Api/irs-api.info.mdx | 25 -- .../Job Api/receive-edc-notification.api.mdx | 42 --- .../Job Api/register-allowed-policy.api.mdx | 50 ---- .../register-bpn-investigation.api.mdx | 50 ---- .../register-ess-investigation-order.api.mdx | 50 ---- .../register-job-for-global-asset-id.api.mdx | 50 ---- .../Job Api/register-order.api.mdx | 50 ---- .../Job Api/sidebar.js | 1 - .../Job Api/update-allowed-policy.api.mdx | 46 --- .../page_software-development-view.md | 4 +- 20 files changed, 1 insertion(+), 1219 deletions(-) delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/delete-allowed-policy.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-allowed-policies.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-allowed-policy.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-ess-investigation-order.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js delete mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/update-allowed-policy.api.mdx diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx deleted file mode 100644 index d37699af972..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: cancel-batch-order -title: "Cancel a batch order for a given orderId." -description: "Cancel a batch order for a given orderId." -sidebar_label: "Cancel a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel a batch order for a given orderId.","operationId":"cancelBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Cancel a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Cancel a batch order for a given orderId.","description":{"content":"Cancel a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel a batch order for a given orderId. - - - -Cancel a batch order for a given orderId. - -
Path Parameters
- -Cancel a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx deleted file mode 100644 index 573901c8b70..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: cancel-job-by-job-id -title: "Cancel job for requested jobId." -description: "Cancel job for requested jobId." -sidebar_label: "Cancel job for requested jobId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Cancel job for requested jobId.","operationId":"cancelJobByJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"completedOn":"2022-02-03T14:48:54.709Z","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","lastModifiedOn":"2022-02-03T14:48:54.709Z","startedOn":"2022-02-03T14:48:54.709Z","state":"CANCELED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"createdOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","example":"Timeout while requesting Digital Registry","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","example":"IrsTimeoutException","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs.","example":"2022-02-03T14:48:54.709Z"}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","example":"e5347c88-a921-11ec-b909-0242ac120002","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string","example":"SerialPart"},"bomLifecycle":{"type":"string","example":"asBuilt","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"callbackUrl":{"type":"string","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","example":false},"depth":{"type":"integer","format":"int32","example":1,"maximum":2147483647,"minimum":0},"direction":{"type":"string","example":"upward","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean","example":false}}},"startedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"state":{"type":"string","example":"COMPLETED","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]}}},"description":"Job with requested jobId canceled."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Cancel job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job for requested jobId not found."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Cancel job for requested jobId.","description":{"content":"Cancel job for requested jobId.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"PUT","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Cancel job for requested jobId. - - - -Cancel job for requested jobId. - -
Path Parameters
- -Job with requested jobId canceled. - -
Schema
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    parameter object
    - -Job parameter of job processing. - -
    summary object
    - -Summary of the job with statistics of the job processing. - -
    asyncFetchedItems object
    - -Statistics of job execution. - -
    bpnLookups object
    - -Statistics of job execution. - -
- -Cancel job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job for requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/delete-allowed-policy.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/delete-allowed-policy.api.mdx deleted file mode 100644 index d334dbbc3e4..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/delete-allowed-policy.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: delete-allowed-policy -title: "Removes a policy that should no longer be accepted in EDC negotiation." -description: "Removes a policy that should no longer be accepted in EDC negotiation." -sidebar_label: "Removes a policy that should no longer be accepted in EDC negotiation." -hide_title: true -hide_table_of_contents: true -api: {"description":"Removes a policy that should no longer be accepted in EDC negotiation.","operationId":"deleteAllowedPolicy","parameters":[{"in":"path","name":"policyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Policy deletion failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"delete","path":"/irs/policies/{policyId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Removes a policy that should no longer be accepted in EDC negotiation.","description":{"content":"Removes a policy that should no longer be accepted in EDC negotiation.","type":"text/plain"},"url":{"path":["irs","policies",":policyId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"policyId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Removes a policy that should no longer be accepted in EDC negotiation. - - - -Removes a policy that should no longer be accepted in EDC negotiation. - -
Path Parameters
- -OK - -
- -Policy deletion failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx deleted file mode 100644 index 044c49dccd6..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-all-aspect-models -title: "Get all available aspect models from semantic hub or local models." -description: "Get all available aspect models from semantic hub or local models." -sidebar_label: "Get all available aspect models from semantic hub or local models." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get all available aspect models from semantic hub or local models.","operationId":"getAllAspectModels","responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"lastUpdated":"2023-02-13T08:18:11.990659500Z","models":[{"urn":"urn:bamm:io.catenax.single_level_bom_as_built:1.0.0#SingleLevelBomAsBuilt","name":"SingleLevelBomAsBuilt","status":"RELEASED","type":"BAMM","version":"1.0.0"},{"urn":"urn:bamm:io.catenax.serial_part:1.0.0#SerialPart","name":"SerialPart","status":"RELEASED","type":"BAMM","version":"1.0.0"}]}}},"schema":{"type":"object","additionalProperties":false,"properties":{"lastUpdated":{"type":"string"},"models":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"urn":{"type":"string"},"version":{"type":"string"}}}}}}}},"description":"Returns all available aspect models."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Aspect Models"],"method":"get","path":"/irs/aspectmodels","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Get all available aspect models from semantic hub or local models.","description":{"content":"Get all available aspect models from semantic hub or local models.","type":"text/plain"},"url":{"path":["irs","aspectmodels"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all available aspect models from semantic hub or local models. - - - -Get all available aspect models from semantic hub or local models. - -
- -Returns all available aspect models. - -
Schema
    models object[]
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-allowed-policies.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-allowed-policies.api.mdx deleted file mode 100644 index f3721afaf98..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-allowed-policies.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-allowed-policies -title: "Lists the registered policies that should be accepted in EDC negotiation." -description: "Lists the registered policies that should be accepted in EDC negotiation." -sidebar_label: "Lists the registered policies that should be accepted in EDC negotiation." -hide_title: true -hide_table_of_contents: true -api: {"description":"Lists the registered policies that should be accepted in EDC negotiation.","operationId":"getAllowedPolicies","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"createdOn":{"type":"string","format":"date-time"},"permissions":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"action":{"type":"string","example":"USE","enum":["ACCESS","USE"]},"constraints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"and":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"leftOperand":{"type":"string","example":"string"},"operator":{"type":"string","example":"eq","enum":["eq","neq","lt","gt","in","lteq","gteq","isA","hasPart","isPartOf","isOneOf","isAllOf","isNoneOf"]},"rightOperand":{"type":"array","items":{"type":"string"},"example":["string"]}}}},"or":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"leftOperand":{"type":"string","example":"string"},"operator":{"type":"string","example":"eq","enum":["eq","neq","lt","gt","in","lteq","gteq","isA","hasPart","isPartOf","isOneOf","isAllOf","isNoneOf"]},"rightOperand":{"type":"array","items":{"type":"string"},"example":["string"]}}}}}}}}}},"policyId":{"type":"string","example":"f253718e-a270-4367-901b-9d50d9bd8462"},"validUntil":{"type":"string","format":"date-time"}}}}}},"description":"Returns the policies."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/policies","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Lists the registered policies that should be accepted in EDC negotiation.","description":{"content":"Lists the registered policies that should be accepted in EDC negotiation.","type":"text/plain"},"url":{"path":["irs","policies"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Lists the registered policies that should be accepted in EDC negotiation. - - - -Lists the registered policies that should be accepted in EDC negotiation. - -
- -Returns the policies. - -
Schema array
    permissions object[]
    constraints object[]
    and object[]
    or object[]
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx deleted file mode 100644 index 1997632405e..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch-order.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: get-batch-order -title: "Get a batch order for a given orderId." -description: "Get a batch order for a given orderId." -sidebar_label: "Get a batch order for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch order for a given orderId.","operationId":"getBatchOrder","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchChecksum":1,"batches":[{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"PARTIAL","batchUrl":"https://../irs/orders/f253718e-a270-4367-901b-9d50d9bd8462/batches/f253718e-a270-4367-901b-9d50d9bd8462","jobsInBatchChecksum":1}],"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","state":"COMPLETED"}}},"schema":{"type":"object","additionalProperties":false,"description":"BatchOrderAck Payload Response.","properties":{"batchChecksum":{"type":"integer","format":"int32","description":"Expected number of batches in order."},"batches":{"type":"array","description":"Array of batches.","items":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}},"maxItems":2147483647},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"state":{"type":"string","description":"The state of the order.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]}}}}},"description":"Get a batch order for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return Batch Order failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order with the requested orderId not found."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Get a batch order for a given orderId.","description":{"content":"Get a batch order for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch order for a given orderId. - - - -Get a batch order for a given orderId. - -
Path Parameters
- -Get a batch order for a given orderId. - -
Schema
    batches object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of batches. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return Batch Order failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch Order with the requested orderId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx deleted file mode 100644 index b14623e5941..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-batch.api.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: get-batch -title: "Get a batch with a given batchId for a given orderId." -description: "Get a batch with a given batchId for a given orderId." -sidebar_label: "Get a batch with a given batchId for a given orderId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Get a batch with a given batchId for a given orderId.","operationId":"getBatch","parameters":[{"description":"Id of the order.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"orderId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":"Id of the batch.","example":"4bce40b8-64c7-41bf-9ca3-e9432c7fef98","in":"path","name":"batchId","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"batchId":"f253718e-a270-4367-901b-9d50d9bd8462","batchNumber":1,"batchProcessingState":"COMPLETED","batchTotal":1,"completedOn":"2022-02-03T14:48:54.709Z","jobs":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"jobsInBatchChecksum":1,"orderId":"f253718e-a270-4367-901b-9d50d9bd8462","startedOn":"2022-02-03T14:48:54.709Z","totalJobs":1}}},"schema":{"type":"object","additionalProperties":false,"description":"Batch model.","properties":{"batchId":{"type":"string","format":"uuid","description":"Id of the batch.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"batchNumber":{"type":"integer","format":"int32","description":"Sequential number begins with first (1.) batch."},"batchProcessingState":{"type":"string","description":"The state of the batch.","enum":["INITIALIZED","COMPLETED","PROCESSING","PARTIAL","ERROR"]},"batchTotal":{"type":"integer","format":"int32","description":"The total number of batches."},"completedOn":{"type":"string","format":"date-time"},"jobs":{"type":"array","description":"Array of jobs.","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}},"maxItems":2147483647},"jobsInBatchChecksum":{"type":"integer","format":"int32","description":"Expected number of jobs in batch."},"orderId":{"type":"string","format":"uuid","description":"Id of the order.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"startedOn":{"type":"string","format":"date-time"},"totalJobs":{"type":"integer","format":"int32","description":"Total amount of jobs inside the order."}}}}},"description":"Get a batch with a given batchId for a given orderId."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return batch failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch with the requested orderId and batchId not found."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/orders/{orderId}/batches/{batchId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Get a batch with a given batchId for a given orderId.","description":{"content":"Get a batch with a given batchId for a given orderId.","type":"text/plain"},"url":{"path":["irs","orders",":orderId","batches",":batchId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the order.","type":"text/plain"},"type":"any","value":"","key":"orderId"},{"disabled":false,"description":{"content":"(Required) Id of the batch.","type":"text/plain"},"type":"any","value":"","key":"batchId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get a batch with a given batchId for a given orderId. - - - -Get a batch with a given batchId for a given orderId. - -
Path Parameters
- -Get a batch with a given batchId for a given orderId. - -
Schema
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    jobs object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Array of jobs. - -
    = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
- -Return batch failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Batch with the requested orderId and batchId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx deleted file mode 100644 index 0cddde7bbf5..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation.api.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -id: get-bpn-investigation -title: "Return job with additional supplyChainImpacted information." -description: "Return job with additional supplyChainImpacted information." -sidebar_label: "Return job with additional supplyChainImpacted information." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with additional supplyChainImpacted information.","operationId":"getBPNInvestigation","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AAXX","manufacturerName":"AB CD"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPart","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":3,"failed":0,"running":0},"bpnLookups":{"completed":3,"failed":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","hasAlternatives":false,"lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","id":"urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8","idShort":"future concept x","specificAssetIds":[{"name":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointProtocol":"HTTPS","endpointProtocolVersion":["1.0"],"href":"https://catena-x.net/vehicle/basedetails/","subprotocol":"DSP","subprotocolBody":"id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net","subprotocolBodyEncoding":"plain"}}],"id":"urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d","idShort":"SingleLevelBomAsPlanned","semanticId":{"keys":[{"type":"ExternalReference","value":"urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned"}],"type":"ModelReference"}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointProtocol":"HTTPS","endpointProtocolVersion":["1.0"],"href":"https://catena-x.net/vehicle/partdetails/","subprotocol":"DSP","subprotocolBody":"id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net","subprotocolBodyEncoding":"plain"}}],"id":"urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90","idShort":"vehicle part details","semanticId":{"keys":[{"type":"Submodel","value":"urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"}],"type":"ModelReference"}}]}],"submodels":[{"aspectType":"supply_chain_impacted","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"supplyChainImpacted":"YES"}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string","example":"BPNL00000003AYRE"},"manufacturerName":{"type":"string","example":"OEM A"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"createdOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","example":"Timeout while requesting Digital Registry","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","example":"IrsTimeoutException","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs.","example":"2022-02-03T14:48:54.709Z"}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","example":"e5347c88-a921-11ec-b909-0242ac120002","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string","example":"SerialPart"},"bomLifecycle":{"type":"string","example":"asBuilt","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"callbackUrl":{"type":"string","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","example":false},"depth":{"type":"integer","format":"int32","example":1,"maximum":2147483647,"minimum":0},"direction":{"type":"string","example":"upward","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean","example":false}}},"startedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"state":{"type":"string","example":"COMPLETED","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string","example":"SingleLevelBomAsBuilt"},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly.","example":"2022-02-03T14:48:54.709Z"},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"hasAlternatives":{"type":"boolean","description":"Expresses whether the part is built-in or whether it is one of several options."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified.","example":"2022-02-03T14:48:54.709Z"},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"],"example":"asBuilt"},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string","example":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece"},"lexicalValue":{"type":"string","example":"piece"}}},"quantityNumber":{"type":"number","example":1,"format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"},"id":{"type":"string","example":"882fc530-b69b-4707-95f6-5dbc5e9baaa8"},"idShort":{"type":"string","example":"future concept x"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","example":"engineserialid"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"value":{"type":"string","example":"12309481209312"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string","example":"HTTP"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"href":{"example":"https://edc.data.plane/{path}/submodel","type":"string"},"endpointProtocol":{"example":"HTTPS","type":"string"},"endpointProtocolVersion":{"type":"array","example":["1.0"],"items":{"type":"string"}},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"id":{"type":"string"},"idShort":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation","EssValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":[]}],"tags":["Environmental and Social Standards"],"method":"get","path":"/ess/bpn/investigations/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Return job with additional supplyChainImpacted information.","description":{"content":"Return job with additional supplyChainImpacted information.","type":"text/plain"},"url":{"path":["ess","bpn","investigations",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with additional supplyChainImpacted information. - - - -Return job with additional supplyChainImpacted information. - -
Path Parameters
- -Return job with item graph for the requested id. - -
Schema
    bpns object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of bpn mappings - -
    job object
    - -Executable unit with meta information and item graph result. - -
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    parameter object
    - -Job parameter of job processing. - -
    summary object
    - -Summary of the job with statistics of the job processing. - -
    asyncFetchedItems object
    - -Statistics of job execution. - -
    bpnLookups object
    - -Statistics of job execution. - -
    relationships object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Relationships between parent and child items. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    quantity object
    - -Quantity component. - -
    measurementUnit object
    shells object[]
    - -**Possible values:** `<= 2147483647` - -
    - -AAS shells. - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    specificAssetIds object[]
    - -**Possible values:** `<= 2147483647` - -
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    subjectId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodelDescriptors object[]
    - -**Possible values:** `<= 2147483647` - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    endpoints object[]
    - -**Possible values:** `<= 2147483647` - -
    protocolInformation object
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodels object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of requested Submodels - -
    payload object
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx deleted file mode 100644 index adc8c9a6a82..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id.api.mdx +++ /dev/null @@ -1,262 +0,0 @@ ---- -id: get-job-for-job-id -title: "Return job with optional item graph result for requested id." -description: "Return job with optional item graph result for requested id." -sidebar_label: "Return job with optional item graph result for requested id." -hide_title: true -hide_table_of_contents: true -api: {"description":"Return job with optional item graph result for requested id.","operationId":"getJobForJobId","parameters":[{"description":"Id of the job.","example":"6c311d29-5753-46d4-b32c-19b918ea93b0","in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid","maxLength":36,"minLength":36}},{"description":"\\ Return job with current processed item graph. \\ Return job with item graph if job is in state COMPLETED, otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[{"manufacturerId":"BPNL00000003AYRE","manufacturerName":"OEM A"}],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPart","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","linkedItem":{"assembledOn":"2022-02-03T14:48:54.709Z","childCatenaXId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","hasAlternatives":false,"lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"asBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}}],"shells":[{"description":[{"language":"en","text":"The shell for a vehicle"}],"globalAssetId":"urn:uuid:a45a2246-f6e1-42da-b47d-5c3b58ed62e9","id":"urn:uuid:882fc530-b69b-4707-95f6-5dbc5e9baaa8","idShort":"future concept x","specificAssetIds":[{"name":"engineserialid","value":"12309481209312"}],"submodelDescriptors":[{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"endpointProtocol":"HTTPS","endpointProtocolVersion":["1.0"],"href":"https://catena-x.net/vehicle/basedetails/","subprotocol":"DSP","subprotocolBody":"id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net","subprotocolBodyEncoding":"plain"}}],"idShort":"SingleLevelBomAsPlanned","id":"urn:uuid:5d25a897-6571-4800-b98c-a3352fbf996d","semanticId":{"type":"ModelReference","keys":[{"type":"ExternalReference","value":"urn:bamm:io.catenax.single_level_bom_as_planned:2.0.0#SingleLevelBomAsPlanned"}]}},{"description":[{"language":"en","text":"Provides base vehicle information"}],"endpoints":[{"interface":"HTTP","protocolInformation":{"href":"https://catena-x.net/vehicle/partdetails/","endpointProtocol":"HTTPS","endpointProtocolVersion":["1.0"],"subprotocol":"DSP","subprotocolBody":"id=urn:uuid:c8159379-4613-48b8-ad52-6baed7afe923;dspEndpoint=https://irs-provider-controlplane3.dev.demo.catena-x.net","subprotocolBodyEncoding":"plain"}}],"id":"urn:uuid:dae4d249-6d66-4818-b576-bf52f3b9ae90","idShort":"vehicle part details","semanticId":{"keys":[{"type":"Submodel","value":"urn:bamm:com.catenax.vehicle:0.1.1#PartDetails"}],"type":"ModelReference"}}]}],"submodels":[{"aspectType":"urn:bamm:io.catenax.single_level_bom_as_built:1.0.0","identification":"urn:uuid:fc784d2a-5506-4e61-8e34-21600f8cdeff","payload":{"catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","childItems":[{"createdOn":"2022-02-03T14:48:54.709Z","catenaXId":"urn:uuid:d9bec1c6-e47c-4d18-ba41-0a5fe8b7f447","lastModifiedOn":"2022-02-03T14:48:54.709Z","lifecycleContext":"AsBuilt","quantity":{"measurementUnit":{"datatypeURI":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece","lexicalValue":"piece"},"quantityNumber":1}}]}}],"tombstones":[{"catenaXId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","endpointURL":"https://catena-x.net/vehicle/partdetails/","processingError":{"errorDetail":"Details to reason of failure","lastAttempt":"2022-02-03T14:48:54.709Z","processStep":"SchemaValidation","retryCounter":0}}]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string","example":"BPNL00000003AYRE"},"manufacturerName":{"type":"string","example":"OEM A"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"createdOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","example":"Timeout while requesting Digital Registry","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","example":"IrsTimeoutException","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs.","example":"2022-02-03T14:48:54.709Z"}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","example":"e5347c88-a921-11ec-b909-0242ac120002","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string","example":"SerialPart"},"bomLifecycle":{"type":"string","example":"asBuilt","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"callbackUrl":{"type":"string","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","example":false},"depth":{"type":"integer","format":"int32","example":1,"maximum":2147483647,"minimum":0},"direction":{"type":"string","example":"upward","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean","example":false}}},"startedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"state":{"type":"string","example":"COMPLETED","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string","example":"SingleLevelBomAsBuilt"},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly.","example":"2022-02-03T14:48:54.709Z"},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"hasAlternatives":{"type":"boolean","description":"Expresses whether the part is built-in or whether it is one of several options."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified.","example":"2022-02-03T14:48:54.709Z"},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"],"example":"asBuilt"},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string","example":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece"},"lexicalValue":{"type":"string","example":"piece"}}},"quantityNumber":{"type":"number","example":1,"format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"},"id":{"type":"string","example":"882fc530-b69b-4707-95f6-5dbc5e9baaa8"},"idShort":{"type":"string","example":"future concept x"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","example":"engineserialid"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"value":{"type":"string","example":"12309481209312"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string","example":"HTTP"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"href":{"example":"https://edc.data.plane/{path}/submodel","type":"string"},"endpointProtocol":{"example":"HTTPS","type":"string"},"endpointProtocolVersion":{"type":"array","example":["1.0"],"items":{"type":"string"}},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"id":{"type":"string"},"idShort":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation","EssValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with item graph for the requested id."},"206":{"content":{"application/json":{"examples":{"complete":{"value":{"bpns":[],"job":{"completedOn":"2022-02-03T14:48:54.709Z","createdOn":"2022-02-03T14:48:54.709Z","exception":{"errorDetail":"Timeout while requesting Digital Registry","exception":"IrsTimeoutException","exceptionDate":"2022-02-03T14:48:54.709Z"},"globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","id":"e5347c88-a921-11ec-b909-0242ac120002","lastModifiedOn":"2022-02-03T14:48:54.709Z","owner":"","parameter":{"aspects":["SerialPart","AddressAspect"],"bomLifecycle":"asBuilt","collectAspects":false,"depth":1,"direction":"downward","lookupBPNs":false},"startedOn":"2022-02-03T14:48:54.709Z","state":"RUNNING","summary":{"asyncFetchedItems":{"completed":0,"failed":0,"running":0}}},"relationships":[],"submodels":[],"tombstones":[]}}},"schema":{"type":"object","additionalProperties":false,"description":"Container for a job with item graph.","properties":{"bpns":{"type":"array","description":"Collection of bpn mappings","items":{"type":"object","additionalProperties":false,"description":"Business partner id with name","properties":{"manufacturerId":{"type":"string","example":"BPNL00000003AYRE"},"manufacturerName":{"type":"string","example":"OEM A"}}},"maxItems":2147483647,"uniqueItems":true},"job":{"type":"object","additionalProperties":false,"description":"Executable unit with meta information and item graph result.","properties":{"completedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"createdOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"exception":{"type":"object","additionalProperties":false,"description":"Job error details.","properties":{"errorDetail":{"type":"string","example":"Timeout while requesting Digital Registry","description":"Detailed exception information.","maxLength":4000},"exception":{"type":"string","description":"Exception name.","example":"IrsTimeoutException","maxLength":100},"exceptionDate":{"type":"string","format":"date-time","description":"Datetime error occurs.","example":"2022-02-03T14:48:54.709Z"}}},"globalAssetId":{"type":"string","description":"Part global unique id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"id":{"type":"string","format":"uuid","example":"e5347c88-a921-11ec-b909-0242ac120002","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"},"lastModifiedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"owner":{"type":"string","description":"The IRS api consumer."},"parameter":{"type":"object","additionalProperties":false,"description":"Job parameter of job processing.","properties":{"aspects":{"type":"string","example":"SerialPart"},"bomLifecycle":{"type":"string","example":"asBuilt","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"callbackUrl":{"type":"string","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","example":false},"depth":{"type":"integer","format":"int32","example":1,"maximum":2147483647,"minimum":0},"direction":{"type":"string","example":"upward","description":"Item graph traversal direction.","enum":["upward","downward"]},"lookupBPNs":{"type":"boolean","example":false}}},"startedOn":{"type":"string","format":"date-time","example":"2022-02-03T14:48:54.709Z"},"state":{"type":"string","example":"COMPLETED","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"summary":{"type":"object","additionalProperties":false,"description":"Summary of the job with statistics of the job processing.","properties":{"asyncFetchedItems":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}},"bpnLookups":{"type":"object","additionalProperties":false,"description":"Statistics of job execution.","properties":{"completed":{"type":"integer","format":"int32","description":"Number of completed item transfers.","maximum":2147483647,"minimum":0},"failed":{"type":"integer","format":"int32","description":"Number of failed item transfers.","maximum":2147483647,"minimum":0},"running":{"type":"integer","format":"int32","description":"Number of running item transfers.","maximum":2147483647,"minimum":0}}}}}},"required":["globalAssetId","id","state"]},"relationships":{"type":"array","description":"Relationships between parent and child items.","items":{"type":"object","additionalProperties":false,"description":"Relationships between parent and child items.","properties":{"aspectType":{"type":"string","example":"SingleLevelBomAsBuilt"},"bpn":{"type":"string","example":"BPNL00000003AYRE"},"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"linkedItem":{"type":"object","additionalProperties":false,"description":"Set of child parts the parent object is assembled by (one structural level down).","properties":{"assembledOn":{"type":"string","format":"date-time","description":"Datetime of assembly.","example":"2022-02-03T14:48:54.709Z"},"childCatenaXId":{"type":"string","description":"CatenaX child global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"hasAlternatives":{"type":"boolean","description":"Expresses whether the part is built-in or whether it is one of several options."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Last datetime item was modified.","example":"2022-02-03T14:48:54.709Z"},"lifecycleContext":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"],"example":"asBuilt"},"quantity":{"type":"object","additionalProperties":false,"description":"Quantity component.","properties":{"measurementUnit":{"type":"object","additionalProperties":false,"properties":{"datatypeURI":{"type":"string","example":"urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece"},"lexicalValue":{"type":"string","example":"piece"}}},"quantityNumber":{"type":"number","example":1,"format":"double","maximum":2147483647,"minimum":0}}}}}}},"maxItems":2147483647},"shells":{"type":"array","description":"AAS shells.","items":{"type":"object","additionalProperties":false,"description":"AAS shells.","properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"},"id":{"type":"string","example":"882fc530-b69b-4707-95f6-5dbc5e9baaa8"},"idShort":{"type":"string","example":"future concept x"},"specificAssetIds":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","example":"engineserialid"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"subjectId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}},"value":{"type":"string","example":"12309481209312"}}},"maxItems":2147483647},"submodelDescriptors":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"administration":{"type":"object","additionalProperties":false,"properties":{"revision":{"type":"string"},"version":{"type":"string"}}},"description":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"language":{"type":"string","example":"en"},"text":{"type":"string","example":"The shell for a vehicle"}}},"maxItems":2147483647},"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"interface":{"type":"string","example":"HTTP"},"protocolInformation":{"type":"object","additionalProperties":false,"properties":{"href":{"example":"https://edc.data.plane/{path}/submodel","type":"string"},"endpointProtocol":{"example":"HTTPS","type":"string"},"endpointProtocolVersion":{"type":"array","example":["1.0"],"items":{"type":"string"}},"subprotocol":{"type":"string"},"subprotocolBody":{"type":"string"},"subprotocolBodyEncoding":{"type":"string"}}}}},"maxItems":2147483647},"id":{"type":"string"},"idShort":{"type":"string"},"semanticId":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","example":"urn:bamm:com.catenax.vehicle:0.1.1"},"value":{"type":"string","example":"Submodel"}}},"maxItems":2147483647}}}}},"maxItems":2147483647}}},"maxItems":2147483647},"submodels":{"type":"array","description":"Collection of requested Submodels","items":{"type":"object","additionalProperties":false,"description":"Submodel with identification of SubmodelDescriptor, aspect type and payload as String","properties":{"aspectType":{"type":"string"},"identification":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"object"}}}},"maxItems":2147483647},"tombstones":{"type":"array","description":"Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.","items":{"type":"object","additionalProperties":false,"description":"Tombstone with information about request failure","properties":{"catenaXId":{"type":"string","description":"CATENA-X global asset id in the format urn:uuid:uuid4.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"},"endpointURL":{"type":"string"},"processingError":{"type":"object","additionalProperties":false,"properties":{"errorDetail":{"type":"string"},"lastAttempt":{"type":"string","format":"date-time"},"processStep":{"type":"string","enum":["SubmodelRequest","DigitalTwinRequest","SchemaValidation","SchemaRequest","BpdmRequest","BpdmValidation","UsagePolicyValidation","EssValidation"]},"retryCounter":{"type":"integer","format":"int32","maximum":2147483647,"minimum":0}}}}},"maxItems":2147483647}}}}},"description":"Return job with current processed item graph for the requested id."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return job failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."},"404":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Not found","messages":["NotFoundException"],"statusCode":"404 NOT_FOUND"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job with the requested jobId not found."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs/{id}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Return job with optional item graph result for requested id.","description":{"content":"Return job with optional item graph result for requested id.","type":"text/plain"},"url":{"path":["irs","jobs",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"\\ Return job with current processed item graph. \\ Return job with item graph if job is in state COMPLETED, otherwise job.","type":"text/plain"},"key":"returnUncompletedJob","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Id of the job.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Return job with optional item graph result for requested id. - - - -Return job with optional item graph result for requested id. - -
Path Parameters
Query Parameters
    Return job with current processed item graph. \\ Return job with item graph if job is in state COMPLETED, otherwise job.","in":"query","name":"returnUncompletedJob","required":false,"schema":{"type":"boolean","default":true}}}>
- -Return job with item graph for the requested id. - -
Schema
    bpns object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of bpn mappings - -
    job object
    - -Executable unit with meta information and item graph result. - -
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    parameter object
    - -Job parameter of job processing. - -
    summary object
    - -Summary of the job with statistics of the job processing. - -
    asyncFetchedItems object
    - -Statistics of job execution. - -
    bpnLookups object
    - -Statistics of job execution. - -
    relationships object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Relationships between parent and child items. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    quantity object
    - -Quantity component. - -
    measurementUnit object
    shells object[]
    - -**Possible values:** `<= 2147483647` - -
    - -AAS shells. - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    specificAssetIds object[]
    - -**Possible values:** `<= 2147483647` - -
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    subjectId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodelDescriptors object[]
    - -**Possible values:** `<= 2147483647` - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    endpoints object[]
    - -**Possible values:** `<= 2147483647` - -
    protocolInformation object
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodels object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of requested Submodels - -
    payload object
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job with current processed item graph for the requested id. - -
Schema
    bpns object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of bpn mappings - -
    job object
    - -Executable unit with meta information and item graph result. - -
    exception object
    - -Job error details. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>= 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    parameter object
    - -Job parameter of job processing. - -
    summary object
    - -Summary of the job with statistics of the job processing. - -
    asyncFetchedItems object
    - -Statistics of job execution. - -
    bpnLookups object
    - -Statistics of job execution. - -
    relationships object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Relationships between parent and child items. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    linkedItem object
    - -Set of child parts the parent object is assembled by (one structural level down). - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    quantity object
    - -Quantity component. - -
    measurementUnit object
    shells object[]
    - -**Possible values:** `<= 2147483647` - -
    - -AAS shells. - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    specificAssetIds object[]
    - -**Possible values:** `<= 2147483647` - -
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    subjectId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodelDescriptors object[]
    - -**Possible values:** `<= 2147483647` - -
    administration object
    description object[]
    - -**Possible values:** `<= 2147483647` - -
    endpoints object[]
    - -**Possible values:** `<= 2147483647` - -
    protocolInformation object
    semanticId object
    keys object[]
    - -**Possible values:** `<= 2147483647` - -
    submodels object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of requested Submodels - -
    payload object
  • property name* object
    • tombstones object[]
    - -**Possible values:** `<= 2147483647` - -
    - -Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL. - -
    = 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    processingError object
- -Return job failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- -Job with the requested jobId not found. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx deleted file mode 100644 index c553f302c25..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-jobs-by-job-states -title: "Returns paginated jobs with state and execution times." -description: "Returns paginated jobs with state and execution times." -sidebar_label: "Returns paginated jobs with state and execution times." -hide_title: true -hide_table_of_contents: true -api: {"description":"Returns paginated jobs with state and execution times.","operationId":"getJobsByJobStates","parameters":[{"description":"Requested job states.","explode":false,"in":"query","name":"states","required":false,"schema":{"type":"array","items":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]},"maxItems":2147483647}},{"description":"Zero-based page index (0..N)","in":"query","name":"page","required":false,"schema":{"type":"integer","default":0}},{"description":"The size of the page to be returned","in":"query","name":"size","required":false,"schema":{"type":"integer","default":20}},{"description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","in":"query","name":"sort","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"content":{"application/json":{"examples":{"complete":{"value":{"content":[{"completedOn":"2022-02-03T14:48:54.709Z","id":"6c311d29-5753-46d4-b32c-19b918ea93b0","startedOn":"2022-02-03T14:48:54.709Z","state":"COMPLETED"}],"pageCount":1,"pageNumber":0,"pageSize":10,"totalElements":1}}},"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"completedOn":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"startedOn":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["UNSAVED","INITIAL","RUNNING","TRANSFERS_FINISHED","COMPLETED","CANCELED","ERROR"]}}}},"pageCount":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"}}}}},"description":"Paginated list of jobs with state and execution times for requested job states."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Return jobs for requested job states failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"get","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Returns paginated jobs with state and execution times.","description":{"content":"Returns paginated jobs with state and execution times.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Requested job states.","type":"text/plain"},"key":"states","value":""},{"disabled":false,"description":{"content":"Zero-based page index (0..N)","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"The size of the page to be returned","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","type":"text/plain"},"key":"sort","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns paginated jobs with state and execution times. - - - -Returns paginated jobs with state and execution times. - -
Query Parameters
- -Paginated list of jobs with state and execution times for requested job states. - -
Schema
    content object[]
- -Return jobs for requested job states failed. - -
Schema
- -No valid authentication credentials. - -
Schema
- -Authorization refused by server. - -
Schema
- \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx deleted file mode 100644 index 5238d2efac3..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: irs-api -title: "IRS API" -description: "The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 2.1.0 - -# IRS API - - - -The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. - -

Authentication

Security Scheme Type:oauth2
clientCredentials OAuth Flow:

Token URL: https://localhost

Scopes:
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx deleted file mode 100644 index a072f39b7bd..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: receive-edc-notification -title: "Accepts notifications sent via EDC." -description: "Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly." -sidebar_label: "Accepts notifications sent via EDC." -hide_title: true -hide_table_of_contents: true -api: {"description":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","operationId":"receiveEdcNotification","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"object","additionalProperties":false,"properties":{"hops":{"type":"integer","format":"int32"},"bpn":{"type":"string"},"result":{"type":"string"}}},"header":{"type":"object","additionalProperties":false,"description":"EDC notification header information","properties":{"notificationId":{"type":"string"},"notificationType":{"type":"string"},"originalNotificationId":{"type":"string"},"recipientBpn":{"type":"string"},"replyAssetId":{"type":"string"},"replyAssetSubPath":{"type":"string"},"senderBpn":{"type":"string"},"senderEdc":{"type":"string"}},"required":["notificationId","notificationType","recipientBpn","senderBpn"]}},"required":["content","header"]}}},"required":true},"responses":{"200":{"description":"Notification received successfully."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Notification malformed."}},"tags":["Environmental and Social Standards"],"method":"post","path":"/ess/notification/receive","servers":[{"url":"http://localhost:8080"}],"security":[{"oAuth2":[]}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"content":{"hops":0,"bpn":"string","result":"string"},"header":{"notificationId":"string","notificationType":"string","originalNotificationId":"string","recipientBpn":"string","replyAssetId":"string","replyAssetSubPath":"string","senderBpn":"string","senderEdc":"string"}},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Accepts notifications sent via EDC.","description":{"content":"Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly.","type":"text/plain"},"url":{"path":["ess","notification","receive"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Accepts notifications sent via EDC. - - - -Accepts notifications via EDC. Notifications are filtered by their type and processed accordingly. - -
    Request Body required
      content object required
      header object required
      - -EDC notification header information - -
    - -Notification received successfully. - -
    - -Notification malformed. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-allowed-policy.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-allowed-policy.api.mdx deleted file mode 100644 index 4f9ff2d31ed..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-allowed-policy.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: register-allowed-policy -title: "Register a policy that should be accepted in EDC negotiation." -description: "Register a policy that should be accepted in EDC negotiation." -sidebar_label: "Register a policy that should be accepted in EDC negotiation." -hide_title: true -hide_table_of_contents: true -api: {"description":"Register a policy that should be accepted in EDC negotiation.","operationId":"registerAllowedPolicy","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request to add a policy","properties":{"permissions":{"type":"array","description":"List of permissions that will be added to the Policy on creation.","items":{"type":"object","additionalProperties":false,"properties":{"action":{"type":"string","example":"USE","enum":["ACCESS","USE"]},"constraints":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"and":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"leftOperand":{"type":"string","example":"string"},"operator":{"type":"string","example":"eq","enum":["eq","neq","lt","gt","in","lteq","gteq","isA","hasPart","isPartOf","isOneOf","isAllOf","isNoneOf"]},"rightOperand":{"type":"array","items":{"type":"string"},"example":["string"]}}}},"or":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"leftOperand":{"type":"string","example":"string"},"operator":{"type":"string","example":"eq","enum":["eq","neq","lt","gt","in","lteq","gteq","isA","hasPart","isPartOf","isOneOf","isAllOf","isNoneOf"]},"rightOperand":{"type":"array","items":{"type":"string"},"example":["string"]}}}}}}}}}},"policyId":{"type":"string","description":"The ID of the policy to add"},"validUntil":{"type":"string","format":"date-time","description":"Timestamp after which the policy will no longer be accepted in negotiations"}},"required":["permissions","policyId","validUntil"]}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Policy registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/policies","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"permissions":[{"action":"USE","constraints":[{"and":[{"leftOperand":"string","operator":"eq","rightOperand":["string"]}],"or":[{"leftOperand":"string","operator":"eq","rightOperand":["string"]}]}]}],"policyId":"string","validUntil":"2023-12-08"},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Register a policy that should be accepted in EDC negotiation.","description":{"content":"Register a policy that should be accepted in EDC negotiation.","type":"text/plain"},"url":{"path":["irs","policies"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Register a policy that should be accepted in EDC negotiation. - - - -Register a policy that should be accepted in EDC negotiation. - -
    Request Body required
      permissions object[] required
      - -List of permissions that will be added to the Policy on creation. - -
      constraints object[]
      and object[]
      or object[]
    - -Created - -
    - -Policy registration failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx deleted file mode 100644 index f2d0777f349..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: register-bpn-investigation -title: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -description: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -sidebar_label: "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","operationId":"registerBPNInvestigation","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"bomLifecycle":{"example":"asPlanned","type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: jobId and jobState.","example":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}"},"key":{"type":"object","additionalProperties":false,"description":"Key object contains required attributes for identify part chain entry node.","properties":{"bpn":{"type":"string","description":"BPN of partner providing the initial asset","example":"BPNL0123456789XX","maxLength":16,"minLength":16},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"required":["bpn","globalAssetId"]},"incidentBPNSs":{"type":"array","items":{"type":"string","pattern":"(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}"},"maxItems":2147483647}},"required":["incidentBPNSs","key"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"description":"The unique jobId handle of the just processed job.","properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Environmental and Social Standards"],"method":"post","path":"/ess/bpn/investigations","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"bomLifecycle":"asPlanned","callbackUrl":"https://hostname.com/callback?jobId={jobId}&jobState={jobState}","key":{"bpn":"BPNL0123456789XX","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"},"incidentBPNSs":["string"]},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","description":{"content":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","type":"text/plain"},"url":{"path":["ess","bpn","investigations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - - - -Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId. - -
    Request Body required
      key object required
      - -Key object contains required attributes for identify part chain entry node. - -
      = 16 characters` and `<= 16 characters`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    - -Returns id of registered job. - -
    Schema
      = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    - -Job registration failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-ess-investigation-order.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-ess-investigation-order.api.mdx deleted file mode 100644 index 02be16d3cb1..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-ess-investigation-order.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: register-ess-investigation-order -title: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." -description: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." -sidebar_label: "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.","operationId":"registerESSInvestigationOrder","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request body for registering a new Batch Order for ESS Investigation Job.","properties":{"batchSize":{"type":"integer","format":"int32","default":20,"description":"Size of the batch.","maximum":100,"minimum":10},"batchStrategy":{"type":"string","description":"The strategy how the batch is processed internally in IRS.","enum":["PRESERVE_BATCH_JOB_ORDER","PRESERVE_JOB_ORDER","PRESERVE_BATCH_ORDER"]},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState.","example":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}"},"incidentBPNSs":{"type":"array","items":{"type":"string","pattern":"(BPN)[LSA][\\w\\d]{10}[\\w\\d]{2}"},"maxItems":2147483647},"jobTimeout":{"type":"integer","format":"int32","default":3600,"description":"Timeout in seconds for each job processing inside the complete order.","maximum":7200,"minimum":60},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Key object contains required attributes for identify part chain entry node.","properties":{"bpn":{"type":"string","description":"BPN of partner providing the initial asset","example":"BPNL0123456789XX","maxLength":16,"minLength":16},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"required":["bpn","globalAssetId"]},"maxItems":2147483647},"timeout":{"type":"integer","format":"int32","default":43200,"description":"Timeout in seconds for the complete batch order processing.","maximum":86400,"minimum":60}},"required":["incidentBPNSs","keys"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"description":"Id of the created Batch order.","properties":{"id":{"type":"string","format":"uuid","description":"Id of the Batch Order."}}}}},"description":"Returns orderId of registered Batch order."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Environmental and Social Standards"],"method":"post","path":"/irs/ess/orders","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"batchSize":20,"batchStrategy":"PRESERVE_BATCH_JOB_ORDER","bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}","incidentBPNSs":["string"],"jobTimeout":3600,"keys":[{"bpn":"BPNL0123456789XX","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"}],"timeout":43200},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.","description":{"content":"Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.","type":"text/plain"},"url":{"path":["irs","ess","orders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches. - - - -Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches. - -
    Request Body required
      = 10` and `<= 100`"} defaultValue={20}>= 60` and `<= 7200`"} defaultValue={3600}>
      keys object[] required
      - -**Possible values:** `<= 2147483647` - -
      = 16 characters` and `<= 16 characters`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
      = 60` and `<= 86400`"} defaultValue={43200}>
    - -Returns orderId of registered Batch order. - -
    Schema
    - -Batch Order registration failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx deleted file mode 100644 index 3a167566633..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: register-job-for-global-asset-id -title: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -description: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -sidebar_label: "Register an IRS job to retrieve an item graph for given {globalAssetId}." -hide_title: true -hide_table_of_contents: true -api: {"description":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","operationId":"registerJobForGlobalAssetId","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"The requested job definition.","properties":{"aspects":{"type":"array","description":"List of aspect names that will be collected if \\ flag is set to true.","items":{"type":"string"},"maxItems":2147483647},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are two uri variable placeholders that can be used: id and state.","example":"https://hostname.com/callback?id={id}&state={state}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"key":{"type":"object","additionalProperties":false,"description":"Key object contains required attributes for identify part chain entry node.","properties":{"bpn":{"type":"string","description":"BPN of partner providing the initial asset","example":"BPNL0123456789XX","maxLength":16,"minLength":16},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"required":["bpn","globalAssetId"]},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."}},"required":["key"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"description":"The unique jobId handle of the just processed job.","properties":{"id":{"type":"string","format":"uuid","description":"Id of the job.","maxLength":36,"minLength":36,"pattern":"/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i"}}}}},"description":"Returns id of registered job."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Job registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/jobs","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?id={id}&state={state}","collectAspects":true,"depth":0,"direction":"downward","key":{"bpn":"BPNL0123456789XX","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"},"lookupBPNs":true},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","description":{"content":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","type":"text/plain"},"url":{"path":["irs","jobs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Register an IRS job to retrieve an item graph for given {globalAssetId}. - - - -Register an IRS job to retrieve an item graph for given {globalAssetId}. - -
    Request Body required
      flag is set to true."} schemaName={"string[]"} qualifierMessage={"**Possible values:** `<= 2147483647`"} defaultValue={undefined}>= 1` and `<= 100`"} defaultValue={undefined}>
      key object required
      - -Key object contains required attributes for identify part chain entry node. - -
      = 16 characters` and `<= 16 characters`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
    - -Returns id of registered job. - -
    Schema
      = 36 characters` and `<= 36 characters`, Value must match regular expression `/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i`"} defaultValue={undefined}>
    - -Job registration failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx deleted file mode 100644 index 508715809f7..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/register-order.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: register-order -title: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -description: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -sidebar_label: "Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches." -hide_title: true -hide_table_of_contents: true -api: {"description":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","operationId":"registerOrder","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request body for registering a new Batch Order.","properties":{"aspects":{"type":"array","items":{"type":"string"},"maxItems":2147483647},"batchSize":{"type":"integer","format":"int32","default":20,"description":"Size of the batch.","maximum":100,"minimum":10},"batchStrategy":{"type":"string","description":"The strategy how the batch is processed internally in IRS.","enum":["PRESERVE_BATCH_JOB_ORDER","PRESERVE_JOB_ORDER","PRESERVE_BATCH_ORDER"]},"bomLifecycle":{"type":"string","description":"The lifecycle context in which the child part was assembled into the parent part.","enum":["asBuilt","asPlanned","asSpecified"]},"callbackUrl":{"type":"string","description":"Callback url to notify requestor when job processing is finished. There are four uri variable placeholders that can be used: orderId, batchId, orderState and batchState.","example":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}"},"collectAspects":{"type":"boolean","description":"Flag to specify whether aspects should be requested and collected. Default is false."},"depth":{"type":"integer","format":"int32","description":"Max depth of the item graph returned. If no depth is set item graph with max depth is returned.","maximum":100,"minimum":1},"direction":{"type":"string","default":"downward","description":"Item graph traversal direction.","enum":["upward","downward"]},"jobTimeout":{"type":"integer","format":"int32","default":3600,"description":"Timeout in seconds for each job processing inside the complete order.","maximum":7200,"minimum":60},"keys":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Key object contains required attributes for identify part chain entry node.","properties":{"bpn":{"type":"string","description":"BPN of partner providing the initial asset","example":"BPNL0123456789XX","maxLength":16,"minLength":16},"globalAssetId":{"type":"string","description":"Id of global asset.","example":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0","maxLength":45,"minLength":45,"pattern":"^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},"required":["bpn","globalAssetId"]},"maxItems":2147483647},"lookupBPNs":{"type":"boolean","description":"Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false."},"timeout":{"type":"integer","format":"int32","default":43200,"description":"Timeout in seconds for the complete batch order processing.","maximum":86400,"minimum":60}},"required":["keys"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"complete":{"value":{"id":"6c311d29-5753-46d4-b32c-19b918ea93b0"}}},"schema":{"type":"object","additionalProperties":false,"description":"Id of the created Batch order.","properties":{"id":{"type":"string","format":"uuid","description":"Id of the Batch Order."}}}}},"description":"Returns orderId of registered Batch order."},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Batch Order registration failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"post","path":"/irs/orders","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"aspects":["string"],"batchSize":20,"batchStrategy":"PRESERVE_BATCH_JOB_ORDER","bomLifecycle":"asBuilt","callbackUrl":"https://hostname.com/callback?orderId={orderId}&batchId={batchId}&orderState={orderState}&batchState={batchState}","collectAspects":true,"depth":0,"direction":"downward","jobTimeout":3600,"keys":[{"bpn":"BPNL0123456789XX","globalAssetId":"urn:uuid:6c311d29-5753-46d4-b32c-19b918ea93b0"}],"lookupBPNs":true,"timeout":43200},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","description":{"content":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","type":"text/plain"},"url":{"path":["irs","orders"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - - - -Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches. - -
    Request Body required
      = 10` and `<= 100`"} defaultValue={20}>= 1` and `<= 100`"} defaultValue={undefined}>= 60` and `<= 7200`"} defaultValue={3600}>
      keys object[] required
      - -**Possible values:** `<= 2147483647` - -
      = 16 characters` and `<= 16 characters`"} defaultValue={undefined}>= 45 characters` and `<= 45 characters`, Value must match regular expression `^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`"} defaultValue={undefined}>
      = 60` and `<= 86400`"} defaultValue={43200}>
    - -Returns orderId of registered Batch order. - -
    Schema
    - -Batch Order registration failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js deleted file mode 100644 index c072d04232a..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/irs-api"},{"type":"category","label":"Environmental- and Social Standards","link":{"type":"generated-index","title":"Environmental- and Social Standards","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/environmental-and-social-standards"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-bpn-investigation","label":"Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-bpn-investigation","label":"Return job with additional supplyChainImpacted information.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/receive-edc-notification","label":"Accepts notifications sent via EDC.","className":"api-method post"}]},{"type":"category","label":"Item Relationship Service","link":{"type":"generated-index","title":"Item Relationship Service","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/item-relationship-service"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-jobs-by-job-states","label":"Returns paginated jobs with state and execution times.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-job-for-global-asset-id","label":"Register an IRS job to retrieve an item graph for given {globalAssetId}.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-job-for-job-id","label":"Return job with optional item graph result for requested id.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-job-by-job-id","label":"Cancel job for requested jobId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/register-order","label":"Registers an IRS order with an array of {globalAssetIds}. Each globalAssetId will be processed in an IRS Job, grouped in batches.","className":"api-method post"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch-order","label":"Get a batch order for a given orderId.","className":"api-method get"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/cancel-batch-order","label":"Cancel a batch order for a given orderId.","className":"api-method put"},{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-batch","label":"Get a batch with a given batchId for a given orderId.","className":"api-method get"}]},{"type":"category","label":"Aspect Models","link":{"type":"generated-index","title":"Aspect Models","slug":"/category/kits/Data Chain Kit/Software Development View/Job Api/aspect-models"},"items":[{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/get-all-aspect-models","label":"Get all available aspect models from semantic hub or local models.","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/update-allowed-policy.api.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/update-allowed-policy.api.mdx deleted file mode 100644 index 6b905171f9d..00000000000 --- a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/update-allowed-policy.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-allowed-policy -title: "Updates an existing policy with new validUntil value." -description: "Updates an existing policy with new validUntil value." -sidebar_label: "Updates an existing policy with new validUntil value." -hide_title: true -hide_table_of_contents: true -api: {"description":"Updates an existing policy with new validUntil value.","operationId":"updateAllowedPolicy","parameters":[{"in":"path","name":"policyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"Request to add a policy","properties":{"validUntil":{"type":"string","format":"date-time","description":"Timestamp after which the policy will no longer be accepted in negotiations"}},"required":["validUntil"]}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Bad request","messages":["BadRequestException"],"statusCode":"400 BAD_REQUEST"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Policy update failed."},"401":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Unauthorized","messages":["UnauthorizedException"],"statusCode":"401 UNAUTHORIZED"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"No valid authentication credentials."},"403":{"content":{"application/json":{"examples":{"error":{"value":{"error":"Forbidden","messages":["ForbiddenException"],"statusCode":"403 FORBIDDEN"}}},"schema":{"type":"object","additionalProperties":false,"description":"Error response.","properties":{"error":{"type":"string","description":"Error."},"messages":{"type":"array","description":"List of error messages.","items":{"type":"string"},"maxItems":2147483647},"statusCode":{"type":"string","description":"Error code.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]}}}}},"description":"Authorization refused by server."}},"security":[{"oAuth2":[]}],"tags":["Item Relationship Service"],"method":"put","path":"/irs/policies/{policyId}","servers":[{"url":"http://localhost:8080"}],"securitySchemes":{"oAuth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://localhost"}},"type":"oauth2"}},"jsonRequestBodyExample":{"validUntil":"2023-12-08"},"info":{"description":"The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners.","title":"IRS API","version":"2.1.0"},"postman":{"name":"Updates an existing policy with new validUntil value.","description":{"content":"Updates an existing policy with new validUntil value.","type":"text/plain"},"url":{"path":["irs","policies",":policyId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"policyId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"oauth2","oauth2":[]}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing policy with new validUntil value. - - - -Updates an existing policy with new validUntil value. - -
    Path Parameters
    Request Body required
    - -OK - -
    - -Policy update failed. - -
    Schema
    - -No valid authentication credentials. - -
    Schema
    - -Authorization refused by server. - -
    Schema
    - \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md index b59aa1b35dd..5e6f9ee73ea 100644 --- a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md @@ -16,6 +16,4 @@ The IRS Rest API provides an easy to use Interface for applications to access cr The IRS REST API is standardized through the Catena-X e.V. and can be found here: -- [> CX-0005 Item Relationship Service API](https://catena-x.net/de/standard-library) - -- [> CX-0045 Data Chain Template](https://catena-x.net/de/standard-library) +- [> CX-0005 Item Relationship Service API](https://eclipse-tractusx.github.io/item-relationship-service/docs/swagger-ui/index.html) From 5aae5f6b90b205586f5b09101341f1709553849d Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Wed, 24 Apr 2024 15:02:25 +0200 Subject: [PATCH 2/4] feat #500 update IRS api spec --- .../Software Development View/page_software-development-view.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md index 5e6f9ee73ea..520a964a754 100644 --- a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md @@ -17,3 +17,5 @@ The IRS Rest API provides an easy to use Interface for applications to access cr The IRS REST API is standardized through the Catena-X e.V. and can be found here: - [> CX-0005 Item Relationship Service API](https://eclipse-tractusx.github.io/item-relationship-service/docs/swagger-ui/index.html) + +- [> CX-0045 Data Chain Template](https://catena-x.net/de/standard-library) From 43776711f4f6f600fe1cc6dccf78e59935e1536b Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Thu, 25 Apr 2024 09:35:38 +0200 Subject: [PATCH 3/4] feat #500 update docs --- .../Job Api/irs-api.info.mdx | 25 +++++++++++++++++++ .../Job Api/sidebar.js | 1 + .../page_software-development-view.md | 4 ++- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx create mode 100644 docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx new file mode 100644 index 00000000000..0430260433b --- /dev/null +++ b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx @@ -0,0 +1,25 @@ +--- +id: irs-api +title: "IRS API" +description: "The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners." +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 2.1.0 + +# IRS API + + + +The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. + + + \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js new file mode 100644 index 00000000000..24e02c4fbf8 --- /dev/null +++ b/docs-kits/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"kits/Data Chain Kit/Software Development View/Job Api/irs-api"}]; \ No newline at end of file diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md index 5e6f9ee73ea..d0bed265393 100644 --- a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md @@ -16,4 +16,6 @@ The IRS Rest API provides an easy to use Interface for applications to access cr The IRS REST API is standardized through the Catena-X e.V. and can be found here: -- [> CX-0005 Item Relationship Service API](https://eclipse-tractusx.github.io/item-relationship-service/docs/swagger-ui/index.html) +- [> CX-0005 Item Relationship Service API]((https://catena-x.net/de/standard-library)) + +- [> CX-0045 Data Chain Template](https://catena-x.net/de/standard-library) From 417331cd54ffc0e365a62366251bbf3a03363d45 Mon Sep 17 00:00:00 2001 From: "Krzysztof Massalski (Extern)" Date: Thu, 25 Apr 2024 09:39:21 +0200 Subject: [PATCH 4/4] feat #500 update docs --- .../Software Development View/page_software-development-view.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md index d0bed265393..b59aa1b35dd 100644 --- a/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ b/docs-kits/kits/Data Chain Kit/Software Development View/page_software-development-view.md @@ -16,6 +16,6 @@ The IRS Rest API provides an easy to use Interface for applications to access cr The IRS REST API is standardized through the Catena-X e.V. and can be found here: -- [> CX-0005 Item Relationship Service API]((https://catena-x.net/de/standard-library)) +- [> CX-0005 Item Relationship Service API](https://catena-x.net/de/standard-library) - [> CX-0045 Data Chain Template](https://catena-x.net/de/standard-library)