Attributes

Quick Navigation

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

GET AttributeTypes/{attributeTypeID}/Attributes

Purpose

Returns a list of attribute definitions by attribute type.

Required Permissions

Attribute Management (Read).

URL Parameters

attributeTypeID: ID of the attribute type.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AttributeID : int,
        AttributeTypeID : int,
        ParentAttributeID : int, // can be null
        ShortName : string,
        LongName : string,
        Description : string,
        ValueInt : int, // can be null
        IsReadOnly: bool,
        ChildAttributes :
        [
            {
                AttributeID : int,
                AttributeTypeID : int,
                ParentAttributeID : int,
                ShortName : string,
                LongName : string,
                Description : string,
                ValueInt : int, // can be null
                IsReadOnly: bool,
            },
            …
        ]
    },
    …
]

Response Codes

200 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

GET Attributes/{id}

Purpose

Returns an attribute definition by ID.

Required Permissions

Attribute Management (Read).

URL Parameters

id: ID of the attribute.

Request Body

None.

Response Body

Content-Type: application/json

{
    AttributeID : int,
    AttributeTypeID : int,
    ParentAttributeID : int, // can be null
    ShortName : string,
    LongName : string,
    Description : string,
    ValueInt : int, // can be null
    IsReadOnly: bool,
    ChildAttributes :
    [
        {
            AttributeID : int,
            AttributeTypeID : int,
            ParentAttributeID : int,
            ShortName : string,
            LongName : string,
            Description : string,
            ValueInt : int, // can be null
            IsReadOnly: bool,
        },
        …
    ]
}

Response Codes

200 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

POST AttributeTypes/{attributeTypeID}/Attributes

Purpose

Creates a new attribute definition by attribute type ID.

Required Permissions

Attribute Management (Read/Write).

URL Parameters

attributeTypeID: ID of the attribute type.

Request Body

Content-Type: application/json

{
    ParentAttributeID : int, // can be null
    ShortName : string,
    LongName : string,
    Description : string,
    ValueInt : int // can be null
}

Request Body Details

Max string length for ShortName and LongName is 64. Max string length for Description is 255.

Response Body

Content-Type: application/json

{
    AttributeID : int,
    AttributeTypeID : int,
    ParentAttributeID : int, // can be null
    ShortName : string,
    LongName : string,
    Description : string,
    ValueInt : int, // can be null
    IsReadOnly: bool,
    ChildAttributes :
    [
        {
            AttributeID : int,
            AttributeTypeID : int,
            ParentAttributeID : int,
            ShortName : string,
            LongName : string,
            Description : string,
            ValueInt : int, // can be null
            IsReadOnly: bool,
        },
        …
    ]
}

Response Codes

201 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

DELETE Attributes/{id}

Purpose

Deletes an attribute definition by ID.

Required Permissions

Attribute Management (Read/Write).

URL Parameters

id: ID of the attribute.

Request Body

None.

Response Body

None.

Response Codes

200 – Request successful.

For more information, please see Common Response Codes.