Collection Item

This endpoint is used to manager collection item for a collection inside the organization

Entity fields:

Path
Type
Description

data.type

string

Should be "step"

data.attributes.category

string

Collection description

data.attributes.description

string

Collection name

data.attributes.hcl

int

Collection priority

data.attribute.key

string

Collection item name

data.attributes.value

string

Collection item value

data.attributes.s

ensitive

boolean

Values is sensitive

Example

POST /api/v1/organization/${ORGANIZATION_ID}/collection/"${COLLECTION_ID}/item/

{
    "data": {
        "type": "item",
        "attributes": {
            "category": "ENV",
            "description": "random_description",
            "hcl": false,
            "key": "random_key",
            "sensitive": true
        }
}

Supported Operations

get

Returns the relationship item

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

Query parameters
filter[item]stringOptional

Filters the collection of item using a 'disjoint' RSQL expression

page[number]integer · int32Optional

Number of pages to return. Can be used with page[size]

page[size]integer · int32Optional

Number of elements per page. Can be used with page[number]

page[offset]integer · int32Optional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer · int32Optional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses
200

Successful response

application/vnd.api+json
get
GET /api/v1/organization/{organizationId}/collection/{collectionId}/item HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "data": [
    {
      "type": "text",
      "id": "text",
      "attributes": {
        "category": null,
        "description": null,
        "hcl": null,
        "key": null,
        "sensitive": null,
        "value": null
      },
      "relationships": {
        "collection": {
          "data": [
            null
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}
post

Creates an item of type item and adds it to item

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

Body
Responses
201

Successful response

application/vnd.api+json
post
POST /api/v1/organization/{organizationId}/collection/{collectionId}/item HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 261

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "category": null,
      "description": null,
      "hcl": null,
      "key": null,
      "sensitive": null,
      "value": null
    },
    "relationships": {
      "collection": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}
201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "category": null,
      "description": null,
      "hcl": null,
      "key": null,
      "sensitive": null,
      "value": null
    },
    "relationships": {
      "collection": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}
get

Returns an instance of type item

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

itemIdstringRequired

item Identifier

Query parameters
Responses
200

Successful response

application/vnd.api+json
get
GET /api/v1/organization/{organizationId}/collection/{collectionId}/item/{itemId} HTTP/1.1
Host: 
Accept: */*
200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "category": null,
      "description": null,
      "hcl": null,
      "key": null,
      "sensitive": null,
      "value": null
    },
    "relationships": {
      "collection": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}
delete

Deletes an instance of type item

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

itemIdstringRequired

item Identifier

Responses
204

Successful response

delete
DELETE /api/v1/organization/{organizationId}/collection/{collectionId}/item/{itemId} HTTP/1.1
Host: 
Accept: */*
204

Successful response

No content
patch

Modifies an instance of type item

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

itemIdstringRequired

item Identifier

Body
Responses
204

Successful response

patch
PATCH /api/v1/organization/{organizationId}/collection/{collectionId}/item/{itemId} HTTP/1.1
Host: 
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 261

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "category": null,
      "description": null,
      "hcl": null,
      "key": null,
      "sensitive": null,
      "value": null
    },
    "relationships": {
      "collection": {
        "data": [
          null
        ]
      }
    }
  },
  "included": [
    {
      "type": "text",
      "id": "text",
      "attributes": {},
      "relationships": {}
    }
  ]
}
204

Successful response

No content
PreviousCollection

Last updated

Was this helpful?