Attribute Types

Quick Navigation

• GET AttributeTypes
• GET AttributeTypes/{id}
• POST AttributeTypes
• DELETE AttributeTypes/{id}

GET AttributeTypes

Purpose

Returns a list of attribute types.

Required Permissions

Attribute Management (Read).

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeTypeID : int,
        Name : string,
        IsReadOnly: bool
    },
    …
]

Response Codes

200 – Request successful. Attribute types in the response body.

For more information, please see Common Response Codes.

GET AttributeTypes/{id}

Purpose

Returns an attribute type by ID.

Required Permissions

Attribute Management (Read).

URL Parameters

id: ID of the attribute type.

Request Body

None.

Response Body

Content-type: application/json

{
    AttributeTypeID : int,
    Name : string,
    IsReadOnly: bool
}

Response Codes

200 – Request successful. Attribute type in the response body.

For more information, please see Common Response Codes.

POST AttributeTypes

Purpose

Creates a new attribute type.

Required Permissions

Attribute Management (Read/Write).

Request Body

Content-Type: application/json

{
    Name : string
}

Request Body Details

Max string length for Name is 64.

Response Body

Content-type: application/json

{
    AttributeTypeID : int,
    Name : string,
    IsReadOnly: bool
}

Response Codes

201 – Request successful. Attribute type in the response body.

For more information, please see Common Response Codes.

DELETE AttributeTypes/{id}

Purpose

Deletes an attribute type and all related attributes by ID.

Required Permissions

Attribute Management (Read/Write).

URL Parameters

id: ID of the attribute type.

Request Body

None.

Response Body

None.

Response Codes

200 – Request successful.

For more information, please see Common Response Codes.