List all projects under a folder
GET /folders/{folder_id}/projects
Lists all projects under the specified folder.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
folder_id |
string |
path |
True |
ID of the folder
|
folder_id |
string |
path |
True |
ID of the folder
|
filter |
string |
query |
False |
Specifies which fields should be matched in order to return a resource when listing a collection. Supported operators:
URL example: "filter=field%20eq%20%27value%27" OpenAPI examples: "field eq 'value'" |
skip |
string |
query |
False |
Specifies the number of resources to skip when listing a collection. URL examples: "skip=1" OpenAPI examples: "1" |
include |
string |
query |
False |
Specifies which fields should be returned when listing a collection. URL examples: "include=id", "include=id,name" OpenAPI examples: "id" |
limit |
string |
query |
False |
Specifies the maximum number of resources to return when listing a collection. URL examples: "limit=2" OpenAPI examples: "2" |
orderBy |
string |
query |
False |
Indicates the sort order of resources when listing a collection. URL examples: "orderBy=name", "orderBy=name%20desc" OpenAPI examples: "name desc" |
count |
string |
query |
False |
Indicates if the total number of resources should be returned in the metadata object. URL examples: "count=true" OpenAPI examples: "true" |
continue |
string |
query |
False |
Indicates the token to resume from when listing a collection. URL examples: "continue=[Continue Token from Collection Metadata]" OpenAPI examples: "[Continue Token from Collection Metadata]" |
Response
Status: 200, List of all projects under a parent folder
Name | Type | Required | Description |
---|---|---|---|
continue |
string |
False |
|
count |
int |
False |
|
items |
True |
||
metadata |
False |
Metadata associated with a list of resources. |
Example response
{
"continue": "string",
"items": [
{
"description": "Added a new resource of ResourceType volume",
"id": "666a3f38-d4fa-5b62-a391-a69029758d32",
"isSystem": "true",
"legacyId": "666a3f38-d4fa-5b62-a391-a69029758d32",
"links": [
{
"hints": {
"allow": [
"string"
],
"permissions": [
"string"
],
"status": "string"
},
"href": "string",
"rel": "string",
"title": "string",
"type": "string"
}
],
"metadata": {
"createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"labels": [
{
"name": "string",
"value": "string"
}
],
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
},
"name": "clusterA",
"ownerOrganizationId": "string",
"parentId": "string",
"rawId": "string",
"resourceClass": "string",
"resourceType": "string",
"tags": [
"object"
],
"type": "application/vnd.netapp.bxp.resource",
"version": "1.0"
}
],
"metadata": {
"createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"labels": [
{
"name": "string",
"value": "string"
}
],
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
}
}
Error
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The request is missing the required bearer token.",
"status": "401",
"title": "Missing bearer token",
"type": "https://bluexp.netapp.io/problems/1"
}
Definitions
See Definitions
accept-post
Provides details about which media types are accepted when creating a resource.
accept-put
Provides details about which media types are accepted when updating a resource.
hints
Name | Type | Required | Description |
---|---|---|---|
accept-post |
False |
Provides details about which media types are accepted when creating a resource. |
|
accept-put |
False |
Provides details about which media types are accepted when updating a resource. |
|
allow |
array[string] |
False |
An array of methods that can be used to interact with the link target. Defined values for collections: "POST" - Indicates if new resources can be created in the collection. Defined values for resources: "PUT" - Indicates if the resource can be modified "DELETE" - Indicates if the resource can be deleted |
permissions |
array[string] |
False |
List of the permissions required to use the link. |
status |
string |
False |
Indicates if the target of the link is deprecated. Defined values are: "deprecated" |
targetSchema
Link to a JSON schema that can be used to validate the target of the link (response body).
The preferred format is a $ref link to an external schema.
This field is optional and should only be included when there is a known schema for the target of the href.
See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details.
type_bxp_link
Link relationship
Name | Type | Required | Description |
---|---|---|---|
hints |
False |
||
href |
string |
True |
String describing a relative URI. |
rel |
string |
True |
The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. |
targetSchema |
False |
Link to a JSON schema that can be used to validate the target of the link (response body). The preferred format is a $ref link to an external schema. This field is optional and should only be included when there is a known schema for the target of the href. See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. |
|
title |
string |
False |
Label of a link so that it can be used as a human-readable identifier (for example, a menu entry). Minimum length: 0 Maximum length: 1023 |
type |
string |
False |
The media type of the target of the href. This field is optional and should be included when there is a known media type for the target of the href. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. |
type_bxp_label
Name/value pair
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_bxp_metadata
Metadata associated with the resource
Name | Type | Required | Description |
---|---|---|---|
createdBy |
string |
False |
UUID of the user who created the resource. |
creationTimestamp |
string |
False |
Resource creation date |
labels |
array[type_bxp_label] |
False |
Array of name/value pairs representing additional information for the resource. |
modificationTimestamp |
string |
False |
Resource modification date. |
modifiedBy |
string |
False |
UUID of the user who modified the resource. |
resource_1.0_get_response_body
Name | Type | Required | Description |
---|---|---|---|
description |
string |
False |
JSON string containing the description of the resource. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. |
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
isSystem |
string |
False |
Specifies if an object is system generated. Defined values are:
|
legacyId |
string |
False |
Unique identifier as understood by the Accounts (tenancy) service. |
links |
array[type_bxp_link] |
False |
|
metadata |
False |
Metadata associated with the resource |
|
name |
string |
True |
JSON string containing a name for the resource. Defined values are:
|
ownerOrganizationId |
string |
False |
JSON string containing the ID of the organization. |
parentId |
string |
False |
JSON string containing the ID of the hierarchy. |
rawId |
string |
False |
JSON string containing the physical ID of the resource. It is the ID as defined by the system (a UUID, a string, or any other defined ID). For example, the UUID of an ONTAP cluster or the UUID of an application in Astra Control.
|
resourceClass |
string |
True |
JSON string containing the resource class. This field is for Accounts (tenancy) compatibility support. |
resourceType |
string |
True |
JSON string containing the resource type. This should be one of the allowed resource types, which should be in the resource types collection. These resource types are defined by the service applications and the BlueXP IAM system. |
tags |
array[tags] |
False |
JSON array of tags (name/value pairs) representing metadata for the resource. |
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
type_bxp_metadata_list
Metadata associated with a list of resources.
Name | Type | Required | Description |
---|---|---|---|
count |
number |
False |
|
createdBy |
string |
False |
UUID of the user who created the resource. |
creationTimestamp |
string |
False |
Resource creation date. |
labels |
array[type_bxp_label] |
False |
Array of name/value pairs representing additional information for the resource. |
modificationTimestamp |
string |
False |
Resource modification date. |
modifiedBy |
string |
False |
UUID of the user who modified the resource. |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid parameter |
reason |
string |
True |
Reason why the parameter is invalid |