GuidesAPI Reference
API Reference

Get a list of resources

get
https://Use API Lookup for a base URL/resources

Get a list of Resources that the caller is allowed to see based on the input query parameters.

Note:

  • If the presented access token has a project scope:
    • The response will only include resources from that project or,
    • If referenceable=true or linkable=true, the response will ONLY include the resources that are available to the caller to link to the project in the token's project scope.
  • If the presented access token has no scope:
    • For access=default or access=manage:
      • The response will include resources from all projects that the caller has access to.
      • For raiEnabled types, the response will also include resources that exist outside of any project.
      • For all other types, the response will NOT include resources that exist outside of any project.
    • For access=readOutsideProject:
      • For raiEnabled types, the response will ONLY include resources that exist outside of a project.
      • For all other types, the response will be empty.
    • For referenceable=true or linkable=true, the response will include the HERE public resources that are available to the caller to link to ANY project and all resources available to be linked to ANY project via Resource Plan Attachments or by virtue of being a Linkable resource to the realm
  • raiEnabled types = [catalog, service, schema, artifact]


Access Control:

  • This API works for tokens with or without a project scope.
Query Params
integer
0 to 100
Defaults to 100

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

string

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

string
required

The type of the resource.

string
enum

Filter the resources accessible to the caller based on the access types. The default value is 'default'. Not applicable to use along with the query parameter 'referenceable=true' or 'linkable=true'

  • If 'default' includes resources where:
    • The user has access to the resource's home project OR
    • The user has access to a project that the resource is linked to as a reference OR
    • The type is raiEnabled and the resource is not in any project and the user has 'read' access to it OR
    • The type is raiEnabled and the resource is not in any project and the user has 'write' access to it OR
    • The type is raiEnabled and the resource is not in any project and the user has 'manage' access to it.
  • If 'manage' includes resources where:
    • The user has access to the resource's home project OR
    • The type is raiEnabled and the resource is not in any project and the user has 'manage' access to it.
  • If 'readOutsideProject' includes resources where:
    • The type is raiEnabled and the resource is not in any project and the user has 'read' access to it.

raiEnabled types = [catalog, service, schema, artifact]

Allowed:
boolean

Get all referenceable(linkable) resources available to the caller to attach as a reference(link) to projects. Only supported value is true. Note - Can be used as a synonym for linkable

A resource is referenceable(linkable) if it is marked as referenceable:

  • and the caller has permission to all reference enabled actions against the resource or,
  • in case of a project scoped token, the caller has effective membership on the projects to attach resources as a reference(link) to the Project.
boolean

Get all linkable resources available to the caller to attach as a link to project. Only supported value is true. Note - Can be used as a synonym for referenceable

Headers
string

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

Responses

Updated 2 months ago

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