Skip to main content
Version: 24.03

Return job with optional item graph result for requested id.​

Return job with optional item graph result for requested id.

Path Parameters
  • id uuid required

    Possible values: >= 36 characters and <= 36 characters

    Id of the job.

    Example: 6c311d29-5753-46d4-b32c-19b918ea93b0
Query Parameters
  • returnUncompletedJob boolean

    Default value: true

    <true> Return job with current processed item graph. <false> Return job with item graph if job is in state COMPLETED, otherwise job.

Responses

Return job with item graph for the requested id.

Schema
  • bpns object[]

    Possible values: <= 2147483647

    Collection of bpn mappings

  • manufacturerId string
  • manufacturerName string
  • job object

    Executable unit with meta information and item graph result.

  • completedOn date-time
  • createdOn date-time
  • exception object

    Job error details.

  • errorDetail string

    Possible values: <= 4000 characters

    Detailed exception information.

  • exception string

    Possible values: <= 100 characters

    Exception name.

  • exceptionDate date-time

    Datetime error occurs.

  • globalAssetId string

    Possible values: >= 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}$

    Part global unique id in the format urn:uuid:uuid4.

  • id uuid

    Possible values: >= 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

    Id of the job.

  • lastModifiedOn date-time
  • owner string

    The IRS api consumer.

  • parameter object

    Job parameter of job processing.

  • aspects string
  • bomLifecycle string

    Possible values: [asBuilt, asPlanned, asSpecified]

    The lifecycle context in which the child part was assembled into the parent part.

  • bpn string
  • callbackUrl string
  • collectAspects boolean
  • depth int32

    Possible values: <= 2147483647

  • direction string

    Possible values: [upward, downward]

    Item graph traversal direction.

  • lookupBPNs boolean
  • startedOn date-time
  • state string

    Possible values: [UNSAVED, INITIAL, RUNNING, TRANSFERS_FINISHED, COMPLETED, CANCELED, ERROR]

  • summary object

    Summary of the job with statistics of the job processing.

  • asyncFetchedItems object

    Statistics of job execution.

  • completed int32

    Possible values: <= 2147483647

    Number of completed item transfers.

  • failed int32

    Possible values: <= 2147483647

    Number of failed item transfers.

  • running int32

    Possible values: <= 2147483647

    Number of running item transfers.

  • bpnLookups object

    Statistics of job execution.

  • completed int32

    Possible values: <= 2147483647

    Number of completed item transfers.

  • failed int32

    Possible values: <= 2147483647

    Number of failed item transfers.

  • running int32

    Possible values: <= 2147483647

    Number of running item transfers.

  • relationships object[]

    Possible values: <= 2147483647

    Relationships between parent and child items.

  • aspectType string
  • bpn string
  • catenaXId string

    Possible values: >= 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}$

    CATENA-X global asset id in the format urn:uuid:uuid4.

  • linkedItem object

    Set of child parts the parent object is assembled by (one structural level down).

  • assembledOn date-time

    Datetime of assembly.

  • childCatenaXId string

    Possible values: >= 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}$

    CatenaX child global asset id in the format urn:uuid:uuid4.

  • hasAlternatives boolean

    Expresses whether the part is built-in or whether it is one of several options.

  • lastModifiedOn date-time

    Last datetime item was modified.

  • lifecycleContext string

    Possible values: [asBuilt, asPlanned, asSpecified]

    The lifecycle context in which the child part was assembled into the parent part.

  • quantity object

    Quantity component.

  • measurementUnit object
  • datatypeURI string
  • lexicalValue string
  • quantityNumber double

    Possible values: <= 2147483647

  • shells object[]

    Possible values: <= 2147483647

    AAS shells.

  • administration object
  • revision string
  • version string
  • description object[]

    Possible values: <= 2147483647

  • language string
  • text string
  • globalAssetId string

    Id of global asset.

  • id string
  • idShort string
  • specificAssetIds object[]

    Possible values: <= 2147483647

  • name string
  • semanticId object
  • type string
  • keys object[]

    Possible values: <= 2147483647

  • type string
  • value string
  • subjectId object
  • type string
  • keys object[]

    Possible values: <= 2147483647

  • type string
  • value string
  • value string
  • submodelDescriptors object[]

    Possible values: <= 2147483647

  • administration object
  • revision string
  • version string
  • description object[]

    Possible values: <= 2147483647

  • language string
  • text string
  • endpoints object[]

    Possible values: <= 2147483647

  • interface string
  • protocolInformation object
  • href string
  • endpointProtocol string
  • endpointProtocolVersion string[]
  • subprotocol string
  • subprotocolBody string
  • subprotocolBodyEncoding string
  • id string
  • idShort string
  • semanticId object
  • type string
  • keys object[]

    Possible values: <= 2147483647

  • type string
  • value string
  • submodels object[]

    Possible values: <= 2147483647

    Collection of requested Submodels

  • aspectType string
  • identification string
  • payload object
  • property name* object
  • tombstones object[]

    Possible values: <= 2147483647

    Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.

  • catenaXId string

    Possible values: >= 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}$

    CATENA-X global asset id in the format urn:uuid:uuid4.

  • endpointURL string
  • processingError object
  • errorDetail string
  • lastAttempt date-time
  • processStep string

    Possible values: [SubmodelRequest, DigitalTwinRequest, SchemaValidation, SchemaRequest, BpdmRequest, BpdmValidation, UsagePolicyValidation, EssValidation]

  • retryCounter int32

    Possible values: <= 2147483647

Loading...