Jump to

• Request
• Response

Update an attribute value sequence

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/attributeSequences/{attributeSequencesUniqID}/child/attributeValueSequences/{attributeValueSequencesUniqID}

Request

Path Parameters

• OrganizationId(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=
• attributeSequencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId, WorkCenterId, ResourceId and AttributeId ---for the Attribute Sequences resource and used to uniquely identify an instance of Attribute Sequences. The client should not generate the hash key value. Instead, the client should query on the Attribute Sequences collection resource with a filter on the primary key values in order to navigate to a specific instance of Attribute Sequences.
  
  For example: attributeSequences?q=OrganizationId=<value1>;WorkCenterId=<value2>;ResourceId=<value3>;AttributeId=<value4>
• attributeValueSequencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId, WorkCenterId, ResourceId, AttributeId and AttributeValueId ---for the Attribute Value Sequences resource and used to uniquely identify an instance of Attribute Value Sequences. The client should not generate the hash key value. Instead, the client should query on the Attribute Value Sequences collection resource with a filter on the primary key values in order to navigate to a specific instance of Attribute Value Sequences.
  
  For example: attributeValueSequences?q=OrganizationId=<value1>;WorkCenterId=<value2>;ResourceId=<value3>;AttributeId=<value4>;AttributeValueId=<value5>

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttributeId: integer (int64)
  Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
• AttributeValueId: integer (int64)
  Value that uniquely identifies the attribute value. It's a primary key of the attribute value.
• AttributeValueSequenceNumber: number
  Number that indicates the attribute value sequence of the same attribute in the ideal sequence.
• LastUpdateDate: string (date-time)
  Date and time when the user most recently updated the resource attribute value sequence.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the resource attribute value sequence.
• LastUpdateLogin: string
  Maximum Length: 32

  Login that the user used when updating the resource attribute value sequence.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the resource attribute value sequence.",
            "nullable":false
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeValueSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the attribute value sequence of the same attribute in the ideal sequence.",
            "nullable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute value. It's a primary key of the attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the resource attribute value sequence.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the resource attribute value sequence.",
            "nullable":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(required):
  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(required):
  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 : productionSchedulingOrganizations-attributeSequences-attributeValueSequences-item-response

Type: object

Show Source

• AttributeId: integer (int64)
  Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
• AttributeValueCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the attribute value.
• AttributeValueId: integer (int64)
  Value that uniquely identifies the attribute value. It's a primary key of the attribute value.
• AttributeValueName: string
  Read Only: true

  Maximum Length: 300

  Name of the attribute value.
• AttributeValueSequenceNumber: number
  Number that indicates the attribute value sequence of the same attribute in the ideal sequence.
• CreatedBy: string
  Maximum Length: 64

  User who created the resource attribute value sequence.
• CreationDate: string (date-time)
  Date and time when the user created the resource attribute value sequence.
• LastUpdateDate: string (date-time)
  Date and time when the user most recently updated the resource attribute value sequence.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the resource attribute value sequence.
• LastUpdateLogin: string
  Maximum Length: 32

  Login that the user used when updating the resource attribute value sequence.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "AttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the resource attribute value sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the resource attribute value sequence.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the resource attribute value sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the attribute value sequence of the same attribute in the ideal sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute value. It's a primary key of the attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the resource attribute value sequence.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the resource attribute value sequence.",
            "nullable":true,
            "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