GuidesAPI Reference
API Reference

Get the requested Projects that the resource belongs to or is referenced in(linked to)

Get the list of Projects that the resource belongs to or is referenced in(linked to). When includeCrossRealmProjects=true and a cross-realm trust is established between home project or realm of the resource and a project or realm that resource is linked to, then returned list will also include that project. In other cases the returned list will only include projects that are in the caller's realm.

Note:

  • If the presented access token has a project scope, the response will include:
    • The home project of the resource
    • The list of Projects that the resource has been linked to
  • If the presented access token has no scope, the response will include:
    • The list of Projects filtered out based on the membership of the caller unless includeNonMemberProjects=true.


Access Control for project scoped call:

  • The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
Path Params
string
required

The hrn that identifies the resource.

Query Params
string

The cursor for pagination. Present only if there is an additional page of data to view.

integer
0 to 100
Defaults to 100

Number of records to return. Default is 100 records. Maximum is 100 records.

string
enum

The relation of the resource. A resource is only returned in the response if it matches the requested relation.

Allowed:
boolean

If true, the list of Projects is not filtered out based on the membership of the caller. Defaults to false.

boolean

If true, the list of Projects will include projects that resource is linked too across realms, if a valid cross-realm trust is established. Defaults to false.

Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json