Jump to

• Request
• Response

Create changeover rules

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/changeoverRules

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=

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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.
• CalendarId: integer (int64)
  Value that uniquely identifies the calendar.
• ChangeoverId: integer (int64)
  Value the uniquely identifies a changeover.
• ChangeoverSequenceNumber: number
  Number that identifies the sequence that defines the order of changeover rules in the organization.
• Cost: number
  Cost of changeover for the changeover rule.
• Duration: number
  Duration associated with the changeover rule.
• 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.
• GroupId: integer (int64)
  Value the uniquely identifies the resource group.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• ToAttributeValueId: integer (int64)
  Value that uniquely identifies the to attribute value.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeoverSequenceNumber":{
            "type":"number",
            "description":"Number that identifies the sequence that defines the order of changeover rules in the organization.",
            "nullable":false
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FromAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the from attribute value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the calendar.",
            "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":true,
            "x-hints":{
                "precision":18
            }
        },
        "Duration":{
            "type":"number",
            "description":"Duration associated with the changeover rule.",
            "nullable":false
        },
        "Cost":{
            "type":"number",
            "description":"Cost of changeover for the changeover rule.",
            "nullable":false
        },
        "GroupId":{
            "type":"integer",
            "description":"Value the uniquely identifies the resource group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeoverId":{
            "type":"integer",
            "description":"Value the uniquely identifies a changeover.",
            "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
        }
    }
}

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-changeoverRules-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.
• CalendarCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the calendar.
• CalendarId: integer (int64)
  Value that uniquely identifies the calendar.
• ChangeoverId: integer (int64)
  Value the uniquely identifies a changeover.
• ChangeoverSequenceNumber: number
  Number that identifies the sequence that defines the order of changeover rules in the organization.
• 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 associated with the changeover rule.
• 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.
• GroupCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the resource group.
• GroupId: integer (int64)
  Value the uniquely identifies the resource group.
• 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.
• ResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• 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.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "ToAttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the to attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromAttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the from attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeoverSequenceNumber":{
            "type":"number",
            "description":"Number that identifies the sequence that defines the order of changeover rules in the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute.",
            "format":"int64",
            "nullable":true,
            "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
        },
        "CalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToAttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the to attribute value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Cost":{
            "type":"number",
            "description":"Cost of changeover for the changeover rule.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "GroupCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the resource group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"Duration associated with the changeover rule.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value the uniquely identifies the resource group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeoverId":{
            "type":"integer",
            "description":"Value the uniquely identifies a changeover.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        }
    }
}

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