Skip to main content
Version: 24.03

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

    Possible values: <= 2147483647

    List of aspect names that will be collected if <collectAspects> flag is set to true.

  • 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 two uri variable placeholders that can be used: id and state.

  • 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.

  • key object required

    Key object contains required attributes for identify part chain entry node.

  • 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.

Responses

Returns id of registered job.

Schema
  • 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.

Loading...