System | Attribute Definitions

Retrieve a list of Attribute Definitions

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Responses

200

OK: Attribute definition list.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

get/v1/system/attribute-definitions

GET /v1/system/attribute-definitions HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "description": "Temporary memory for fast data access.",
      "knownValues": [
        {
          "id": 4,
          "displayValue": "8 GB",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "id": 4,
      "name": "RAM",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a new attribute definition

post

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

namestring · max: 50Required

The name of the attribute.

Example: RAM

descriptionstring · max: 500 · nullableOptional

A further description of the attribute.

Example: Temporary memory for fast data access.

Responses

201

Created: The created attribute definition.

application/json

descriptionstring · nullableOptional

A further description of the attribute

Example: Temporary memory for fast data access.

idinteger · int32Optional

The identifier of the attribute definition.

Example: 4

namestring · nullableOptional

The name of the attribute.

Example: RAM

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid API key.

application/json

403

Forbidden: Resource access denied.

application/json

post/v1/system/attribute-definitions

POST /v1/system/attribute-definitions HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "values": [
    {
      "displayValue": "8 GB"
    }
  ],
  "name": "RAM",
  "description": "Temporary memory for fast data access."
}

{
  "description": "Temporary memory for fast data access.",
  "knownValues": [
    {
      "id": 4,
      "displayValue": "8 GB",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "id": 4,
  "name": "RAM",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single attribute definition by its ID

get

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

definitionIdinteger · int32Required

The identifier of the attribute definition.

Responses

200

OK: The requested attribute definition.

application/json

descriptionstring · nullableOptional

A further description of the attribute

Example: Temporary memory for fast data access.

idinteger · int32Optional

The identifier of the attribute definition.

Example: 4

namestring · nullableOptional

The name of the attribute.

Example: RAM

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid API key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/system/attribute-definitions/{definitionId}

GET /v1/system/attribute-definitions/{definitionId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "description": "Temporary memory for fast data access.",
  "knownValues": [
    {
      "id": 4,
      "displayValue": "8 GB",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "id": 4,
  "name": "RAM",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Delete an existing attribute definition

delete

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

definitionIdinteger · int32Required

The identifier of the attribute definition to be deleted.

Responses

204

NoContent: Delete successfully.

No content

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid API key.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

delete/v1/system/attribute-definitions/{definitionId}

DELETE /v1/system/attribute-definitions/{definitionId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Partially update an existing attribute definition

patch

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

definitionIdinteger · int32Required

The identifier of the attribute definition.

Bodyobject · Operation[]

valueany · nullableOptional

pathstring · nullableOptional

opstring · nullableOptional

fromstring · nullableOptional

Responses

204

NoContent: Update successful.

No content

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid API key.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

patch/v1/system/attribute-definitions/{definitionId}

PATCH /v1/system/attribute-definitions/{definitionId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127

[
  {
    "op": "add",
    "path": "/name",
    "value": "RAM"
  },
  {
    "op": "add",
    "path": "/description",
    "value": "Temporary memory for fast data access."
  }
]

No content

Create a new attribute value for a definition

post

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

definitionIdinteger · int32Required

Information for which attribute definition the value should be created.

Body

displayValuestring · max: 50Required

The value for the attribute to be displayed.

Example: 8 GB

Responses

201

Created: The created attribute value.

application/json

idinteger · int32Optional

The identifier of the attribute value.

Example: 4

displayValuestring · nullableOptional

The value for the attribute to be displayed.

Example: 8 GB

400

Bad request: Body validation failed. See response message for details.

application/json

401

Unauthorized: Invalid API key.

application/json

403

Forbidden: Resource access denied.

application/json

post/v1/system/attribute-definitions/{definitionId}/values

POST /v1/system/attribute-definitions/{definitionId}/values HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "displayValue": "8 GB"
}

{
  "id": 4,
  "displayValue": "8 GB",
  "self": {
    "href": "text",
    "method": "text"
  }
}