Jump to

• Request
• Response

Update a changeover instance detail

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverInstances/{changeoverInstancesUniqID}/child/changeoverInstanceDetails/{changeoverInstanceDetailsUniqID}

Request

Path Parameters

• PlanId(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=
• changeoverInstanceDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, ChangeoverInstanceId and AttributeId ---for the Changeover Instance Details resource and used to uniquely identify an instance of Changeover Instance Details. The client should not generate the hash key value. Instead, the client should query on the Changeover Instance Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Changeover Instance Details.
  
  For example: changeoverInstanceDetails?q=PlanId=<value1>;ChangeoverInstanceId=<value2>;AttributeId=<value3>
• changeoverInstancesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and ChangeoverInstanceId ---for the Changeover Instances resource and used to uniquely identify an instance of Changeover Instances. The client should not generate the hash key value. Instead, the client should query on the Changeover Instances collection resource with a filter on the primary key values in order to navigate to a specific instance of Changeover Instances.
  
  For example: changeoverInstances?q=PlanId=<value1>;ChangeoverInstanceId=<value2>

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.
• ChangeoverInstanceId: integer (int64)
  Value that uniquely identifies the changeover instance.
• Cost: number
  Cost of changeover for the changeover rule.
• Duration: number
  Duration of the changeover instance.
• DurationUnit: string
  Maximum Length: 30

  Time unit of measure for the duration. Valid values include seconds, minutes, hours, days.
• FromAttributeValueId: integer (int64)
  Value that uniquely identifies the from attribute value.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ToAttributeValueId: integer (int64)
  Value that uniquely identifies the to attribute value.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FromAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the from attribute value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ToAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the to attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DurationUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the duration. Valid values include seconds, minutes, hours, days.",
            "nullable":true
        },
        "Duration":{
            "type":"number",
            "description":"Duration of the changeover instance.",
            "nullable":false
        },
        "Cost":{
            "type":"number",
            "description":"Cost of changeover for the changeover rule.",
            "nullable":false
        },
        "ChangeoverInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the changeover instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : productionSchedulingPlans-changeoverInstances-changeoverInstanceDetails-item-response

Type: object

Show Source

• AttributeCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the attribute.
• AttributeId: integer (int64)
  Value that uniquely identifies the attribute.
• AttributeName: string
  Read Only: true

  Maximum Length: 100

  Name of the attribute for a changeover instance.
• ChangeoverInstanceId: integer (int64)
  Value that uniquely identifies the changeover instance.
• Cost: number
  Cost of changeover for the changeover rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• Duration: number
  Duration of the changeover instance.
• DurationUnit: string
  Maximum Length: 30

  Time unit of measure for the duration. Valid values include seconds, minutes, hours, days.
• FromAttributeValueCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the from attribute value.
• FromAttributeValueId: integer (int64)
  Value that uniquely identifies the from attribute value.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ToAttributeValueCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the to attribute value.
• ToAttributeValueId: integer (int64)
  Value that uniquely identifies the to attribute value.

{
    "type":"object",
    "properties":{
        "ToAttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the to attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FromAttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the from attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the from attribute value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the to attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"Duration of the changeover instance.",
            "nullable":false,
            "x-queryable":true
        },
        "Cost":{
            "type":"number",
            "description":"Cost of changeover for the changeover rule.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DurationUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the duration. Valid values include seconds, minutes, hours, days.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the attribute for a changeover instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeoverInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the changeover instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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