Jump to

• Request
• Response

Update operational attribute controls of one item

patch

/fscmRestApi/resources/11.13.18.05/itemOperationalAttributeControlLevels/{itemOperationalAttributeControlLevelsUniqID}

Request

Path Parameters

• itemOperationalAttributeControlLevelsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AttrGroupName and AttrName ---for the Item Operational Attribute Control Levels resource and used to uniquely identify an instance of Item Operational Attribute Control Levels. The client should not generate the hash key value. Instead, the client should query on the Item Operational Attribute Control Levels collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Operational Attribute Control Levels.
  
  For example: itemOperationalAttributeControlLevels?q=AttrGroupName=<value1>;AttrName=<value2>

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

• ControlLevel: string
  Title: Controlled At

  Maximum Length: 1

  Control level associated with the attribute.
• MaximumDecimalDigits: integer (int32)
  Title: Maximum Decimal Digits

  Maximum decimal digits that can be set for the attribute value.

{
    "type":"object",
    "properties":{
        "ControlLevel":{
            "title":"Controlled At",
            "maxLength":1,
            "type":"string",
            "description":"Control level associated with the attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "MaximumDecimalDigits":{
            "title":"Maximum Decimal Digits",
            "type":"integer",
            "description":"Maximum decimal digits that can be set for the attribute value.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            }
        }
    }
}

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 : itemOperationalAttributeControlLevels-item-response

Type: object

Show Source

• AttrDataType: string
  Title: Data Type

  Maximum Length: 20

  Data type of the attribute.
• AttrDispName: string
  Title: Attribute

  Maximum Length: 80

  Display name of the attribute.
• AttrGroupDispName: string
  Title: Attribute Group

  Maximum Length: 80

  Display name of the attribute group.
• AttrGroupName: string
  Maximum Length: 30

  Indicates the name of the attribute group.
• AttrName: string
  Maximum Length: 30

  Name of the attribute.
• ControlLevel: string
  Title: Controlled At

  Maximum Length: 1

  Control level associated with the attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the set of selected attributes.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the set of selected attributes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumDecimalDigits: integer (int32)
  Title: Maximum Decimal Digits

  Maximum decimal digits that can be set for the attribute value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the set of selected attributes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the attribute.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "AttrDispName":{
            "title":"Attribute",
            "maxLength":80,
            "type":"string",
            "description":"Display name of the attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttrGroupDispName":{
            "title":"Attribute Group",
            "maxLength":80,
            "type":"string",
            "description":"Display name of the attribute group.",
            "nullable":false,
            "x-queryable":true
        },
        "AttrGroupName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the name of the attribute group.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "ControlLevel":{
            "title":"Controlled At",
            "maxLength":1,
            "type":"string",
            "description":"Control level associated with the attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the set of selected attributes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrDataType":{
            "title":"Data Type",
            "maxLength":20,
            "type":"string",
            "description":"Data type of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDecimalDigits":{
            "title":"Maximum Decimal Digits",
            "type":"integer",
            "description":"Maximum decimal digits that can be set for the attribute value.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        }
    }
}

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