project resource

The OLP CLI supports the following:

list all resources and subresources in a project
link a resource or a subresource list to a project
unlink a resource or a subresource list from a project

project resource list

Retrieves all resources and subresources that are in a project.

olp project resource list <project HRN> [command options]

Required parameters:

<project HRN> The HRN of the project.

Optional parameters:

--type <resource type> Type of resource to be listed for the specified <project HRN>. Acceptable values: catalog,pipeline,pipeline-template,schema,artifact,flow,flow-pattern,service.
--relation <home|reference> The relation of resources to the project. home denotes a resource located within a project while reference denotes a resource linked to the project.
--limit <max number of entities> Specifies the maximum number of entities returned in the result (500 by default).
--credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the platform portal.
--profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
--json Displays the command result in JSON format.
--quiet Displays the resources' HRNs, each on a new line.

For more information on using credentials and profiles, see Credentials setup.

Example:


olp project resource list hrn:here:authorization::org:project/my-project-0000 --json

Output:


{
  "resources": [
    {
      "resource": "hrn:here:pipeline::org:ae7397ea-38fb-4b96-831c-b89a4ec28bc2",
      "project": "hrn:here:authorization::org:project/my-project-0000",
      "type": "pipeline",
      "relation": "home"
    },
    {
      "resource": "hrn:here:data::org:my-catalog",
      "project": "hrn:here:authorization::org:project/my-project-0000",
      "type": "catalog",
      "relation": "reference",
      "allowedActions": [
        "readResource",
        "writeResource"
      ],
      "active": true,
      "linkedOptions": [
        {
            "allowedActions": [
                "readResource"
                "writeResource"
            ],
            "active": true
        },
        {
            "externalId": "A-S0001234",
            "allowedActions": [
                "readResource"
            ],
            "subresources": [
                "USA-IL-CHICAGO",
                "DEU"
            ],
            "active": true
        }
      ]  
   }
  ]
}

Note

The parameter “active” indicates whether or not the link to the resource in that project is active or not. A resource in a project where active is “true” is one that can be used in the project. A resource in a project where active is “false” means that a link to this resource was created in the project at some point but is no longer active, for example, because the subscription that included access to that resource has been cancelled. In this example, the resource is reactivated automatically if your organization renews or subscribes to a different plan that includes this same resource and you wish to use it in this project.