Price get relationship request

Description

This API traverses one or more relationships to retrieve the set of objects associated with the Price object specified by the guid in the URI. To learn more about retrieving object relationships, see Relationship traversal. For a list of relationship APIs available in the Price class, see Price class relationship APIs.

API stability classification

Uncommitted

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

GET

csm/Price/guid/relation+

Price

0..1

HTTP request message

Query string parameters

Use the fillFields and ignoreFields query string parameters to specify which attributes and relationships to return in the response. Use only one of these parameters in the request; they are mutually exclusive. If you do not send a parameter with the request, the response includes all attributes and relationships of the Price object.

Name

Type

Multi-
plicity

Description

fillFields

String

0..1

List of attributes and relationships to include in the response

ignoreFields

String

0..1

List of attributes and relationships to omit from the response

Request message headers

This API uses only common request headers listed in HTTP request and response headers.

Request message body

This API does not use a request message body.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Price object.

Description

This API traverses one or more relationships to retrieve the set of objects associated with the Price object specified by the guid in the URI. To learn more about retrieving object relationships, see Relationship traversal. For a list of relationship APIs available in the Price class, see Price class relationship APIs.

API stability classification

Uncommitted

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

GET

csm/Price/guid/relation+

Price

0..1

HTTP request message

Query string parameters

Use the fillFields and ignoreFields query string parameters to specify which attributes and relationships to return in the response. Use only one of these parameters in the request; they are mutually exclusive. If you do not send a parameter with the request, the response includes all attributes and relationships of the Price object.

Name

Type

Multi-
plicity

Description

fillFields

String

0..1

List of attributes and relationships to include in the response

ignoreFields

String

0..1

List of attributes and relationships to omit from the response

Request message headers

This API uses only common request headers listed in HTTP request and response headers.

Request message body

This API does not use a request message body.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Price object.

Unable to render {include} Already included page 'Price get relationship request', stopping.

Was this page helpful? Yes No Submitting... Thank you

Comments