Jump to

• Request
• Response

Update an attribute value

patch

/fscmRestApi/resources/11.13.18.05/assetGroups/{GroupId}/child/groupingAttributeValues/{GroupValueId}

Request

Path Parameters

• GroupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• GroupValueId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeName: string
  Name of the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.
• AttributeValue: string
  Value for the attribute for the group. This attribute is required.
• GroupValueId: integer (int64)
  Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "type":"string",
            "description":"Name of the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.",
            "nullable":true
        },
        "AttributeValue":{
            "type":"string",
            "description":"Value for the attribute for the group. This attribute is required.",
            "nullable":true
        },
        "GroupValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assetGroups-groupingAttributeValues-item-response

Type: object

Show Source

• AttributeCode: string
  Abbreviation that uniquely identifies the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.
• AttributeDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the grouping assets in the asset group.
• AttributeId: integer (int64)
  Read Only: true

  Unique identifier of the attribute of the grouping assets in the asset group.
• AttributeName: string
  Name of the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.
• AttributeValue: string
  Value for the attribute for the group. This attribute is required.
• GroupValueId: integer (int64)
  Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "type":"string",
            "description":"Abbreviation that uniquely identifies the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the grouping assets in the asset group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Unique identifier of the attribute of the grouping assets in the asset group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255,
                "dependencies":[
                    "PrimaryKeyId"
                ]
            },
            "x-queryable":true
        },
        "AttributeName":{
            "type":"string",
            "description":"Name of the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "type":"string",
            "description":"Value for the attribute for the group. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top