REST Resources

/api/space/tag-management/customized-attribute-labels/{id}

The following operations are supported on this resource:

  • GET - Get a customized attribute label by ID
  • PUT - Edit Customized Attribute Label
  • DELETE - Removes the label only if its an orphan and its not predefined
GET /customized-attribute-labels/{id} Version 4

Get a customized attribute label by ID.

Sample Usage

GET /customized-attribute-labels/{id}


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path ID Y
  • Sample Output XML:
    <customized-attribute-label
         href="/api/space/tag-management/customized-attribute-labels/1184" uri="/api/space/tag-management/customized-attribute-labels/1184">
         <id>1184</id>
         <promoted-column-index>0</promoted-column-index>
         <customized-attribute-category
               href="/api/space/tag-management/customized-attribute-categories/1181" >
               <id>1181</id>
         </customized-attribute-category>
         <name>Device Alias</name>
    </customized-attribute-label>

  • Sample Output JSON:
    {
       "customized-attribute-label" : {
         "@href" :
         "/api/space/tag-management/customized-attribute-labels/1184"
         ,
         "@uri" : "/api/space/tag-management/customized-attribute-labels/1184" ,
         "id" : 1184 ,
         "promoted-column-index" : "0" ,
         "customized-attribute-category" : {
           "@href" :
           "/api/space/tag-management/customized-attribute-categories/1181"
           ,
           "@uri" : "/api/space/tag-management/customized-attribute-labels/1184" ,
           "id" : 1184
         } ,
         "name" : "Device Alias"
       }
    }

    • Access Control

    The following capabilities are required to access this API: ManageLabelsCap

    PUT /customized-attribute-labels/{id} Version 4

    Edit Customized Attribute Label.

    Sample Usage

    PUT /customized-attribute-labels/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path   Y
  • Sample Input XML:
    <customized-attribute-label>
         <name>sample</name>
    </customized-attribute-label>

  • Sample Output XML:
    <customized-attribute-label
         href="/api/space/tag-management/customized-attribute-labels/6094875" uri="/api/space/tag-management/customized-attribute-labels/6094875">
         <id>6094875</id>
         <promoted-column-index>0</promoted-column-index>
         <customized-attribute-category
               href="/api/space/tag-management/customized-attribute-categories/6094844">
               <id>6094844</id>
         </customized-attribute-category>
         <name>sample</name>
    </customized-attribute-label>

  • Sample Input JSON:
    {
       "customized-attribute-label" : {
         "name" : "sample"
       }
    }

  • Sample Output JSON:
    {
       "customized-attribute-label" : {
         "@href" : "/api/space/tag-management/customized-attribute-labels/6094875" ,
         "@uri" : "/api/space/tag-management/customized-attribute-labels/6094875" ,
         "id" : 6094875 ,
         "promoted-column-index" : 0 ,
         "customized-attribute-category" : {
           "@href" : "/api/space/tag-management/customized-attribute-categories/6094844" ,
           "id" : 6094844
         } ,
         "name" : "sample"
       }
    }

    • Access Control

    The following capabilities are required to access this API: ModifyManageLabelsCap

    DELETE /customized-attribute-labels/{id} Version 4

    Removes the label only if its an orphan and its not predefined.

    Sample Usage

    DELETE /customized-attribute-labels/{id}


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path ID Y

    Access Control

    The following capabilities are required to access this API: DeleteManageLabelsCap