Skip to main content
Version: 24.03

Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs​

Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs

Query Parameters
  • page string

    Default value: 0

    Number of page to get results from

  • size string

    Possible values: <= 100

    Default value: 10

    Size of each page

  • businessPartnerType string

    Possible values: [LEGAL_ENTITY, SITE, ADDRESS, GENERIC]

    Business partner type

  • externalIds string[]

    External IDs

Responses

Page of sharing states

Schema
  • totalElements int64

    Total number of all results in all pages

  • totalPages int32

    Total number pages

  • page int32

    Current page number

  • contentSize int32

    Number of results in the page

  • content object[]

    Collection of results in the page

  • businessPartnerType string

    Possible values: [LEGAL_ENTITY, SITE, ADDRESS, GENERIC]

    One of the types of business partners for which the sharing state entry was created.

  • externalId string

    The external identifier of the business partner for which the sharing state entry was created.

  • sharingStateType string

    Possible values: [Pending, Success, Error, Initial, Ready]

    One of the sharing state types of the current sharing state.

  • sharingErrorCode string

    Possible values: [SharingProcessError, SharingTimeout, BpnNotInPool, MissingTaskID]

    One of the sharing error codes in case the current sharing state type is "error".

  • sharingErrorMessage string

    The error message in case the current sharing state type is "error".

  • bpn string

    The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA.

  • sharingProcessStarted date-time

    The date and time when the sharing process was started.

  • taskId string

    The orchestrator task identifier that was created

Loading...