Provider get relationship request

Description

This API traverses one or more relationships to retrieve the set of objects associated with the Provider 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 Provider class, see Provider class relationship APIs.

API stability classification

Committed

API overview

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 Provider object.
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

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 response headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Provider object.
Unknown macro: confluence_report-block. Click on this message for details.
The [confluence_report-block] macro is not in the list of registered macros. Verify the spelling or contact your administrator.