Skip to main content
Version: 24.03

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
  • aspects string[]

    Possible values: <= 2147483647

  • batchSize int32

    Possible values: >= 10 and <= 100

    Default value: 20

    Size of the batch.

  • batchStrategy string

    Possible values: [PRESERVE_BATCH_JOB_ORDER, PRESERVE_JOB_ORDER, PRESERVE_BATCH_ORDER]

    The strategy how the batch is processed internally in IRS.

  • bomLifecycle string

    Possible values: [asBuilt, asPlanned, asSpecified]

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

  • callbackUrl string

    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.

  • collectAspects boolean

    Flag to specify whether aspects should be requested and collected. Default is false.

  • depth int32

    Possible values: >= 1 and <= 100

    Max depth of the item graph returned. If no depth is set item graph with max depth is returned.

  • direction string

    Possible values: [upward, downward]

    Default value: downward

    Item graph traversal direction.

  • jobTimeout int32

    Possible values: >= 60 and <= 7200

    Default value: 3600

    Timeout in seconds for each job processing inside the complete order.

  • keys object[] required

    Possible values: <= 2147483647

  • bpn string required

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

    BPN of partner providing the initial asset

  • globalAssetId string required

    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}$

    Id of global asset.

  • lookupBPNs boolean

    Flag to specify whether BPNs should be collected and resolved via the configured BPDM URL. Default is false.

  • timeout int32

    Possible values: >= 60 and <= 86400

    Default value: 43200

    Timeout in seconds for the complete batch order processing.

Responses

Returns orderId of registered Batch order.

Schema
  • id uuid

    Id of the Batch Order.

Loading...