Read all DeletedBPRelationships

Retrieves a list of deleted relationships between business partners from the database

With this method, you send a request to the server to retrieve a subset of all deleted relationships between business partners (persons or organizations), according to the filter criteria provided. For a collective request for a set of deleted relationships, you have these options:

  • You can define that the set of matching deleted relationships shall not be transmitted all at once, but in a paged manner so that only a small number of results is transmitted, thereby reducing the server load.

Request

URI: /DeletedBPRelationships

HTTP Method: GET

Permissions: <bp>.pd

Query String Parameters

Name Required Data Type Description
$skip No integer Number of the first n records to be excluded from the result set
$top No integer Number of records to include in the result set
$orderby No string Field name to be used for sorting the result set in ascending order
$filter No string Filter condition to be applied; valid fields are businessPartner1ID, businessPartner2ID, and relationshipType
$count No integer Returns the number of entries in the database, with filter conditions taken into account (if applicable)
Allowed Combinations of Fields and Operators in Filter Conditions
Fields Operators
businessPartner1ID, businessPartner2ID, relationshipType eq, ne

Request Example

/DeletedBPRelationships

Retrieves all deleted business partner relationships that are available in the database.

/DeletedBPRelationships?$top=25&$orderby='relationshipType'

Retrieves the first 25 deleted relationships. Data is retrieved in page mode to reduce network load and response times, and the retrieved deleted relationships are sorted by type.

/DeletedBPRelationships?$skip=10&$top=20

Retrieves 20 deleted relationships from the database where the first 10 deleted relationships are omitted. That is, the retrieved deleted relationships are those with sequence numbers 11 through 30.

Response

Response Status and Error Codes

Code Reason
200 Deleted relationships retrieved successfully