Attributes

Quick Navigation

GET AttributeTypes/{attributeTypeID}/Attributes

Returns a list of attribute definitions by Attribute Type.

Attribute Management (Read)

attributeTypeID: ID of the Attribute Type.

None

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,
            },
            …
        ]
    },
    …
]

200 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

GET Attributes/{id}

Returns an attribute definition by ID.

Attribute Management (Read)

id: ID of the Attribute.

None

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,
        },
        …
    ]
}

200 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

POST AttributeTypes/{attributeTypeID}/Attributes

Creates a new attribute definition by Attribute Type ID.

Attribute Management (Read/Write)

attributeTypeID: ID of the Attribute Type.

Content-Type: application/json

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

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

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,
        },
        …
    ]
}

201 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

DELETE Attributes/{id}

Deletes an attribute definition by ID.

Attribute Management (Read/Write)

id: ID of the Attribute.

None

None

200 – Request successful.

For more information, please see Common Response Codes.