Jump to

• Request
• Response

Update production lines

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/productionLines/{productionLinesUniqID}

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=
• productionLinesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and ProductionLineId ---for the Production Lines resource and used to uniquely identify an instance of Production Lines. The client should not generate the hash key value. Instead, the client should query on the Production Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Production Lines.
  
  For example: productionLines?q=PlanId=<value1>;ProductionLineId=<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

• AvailabilityCalendarId: integer (int64)
  Value that uniquely identifies the available calendar.
• LineRate: number
  Hourly rate at which production should progress on the line.
• NumberOfLineOperations: integer (int32)
  Identifies the number of operations on a production line.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ProductionLineCode: string
  Maximum Length: 30

  Code that identifies the production line.
• ProductionLineDescription: string
  Maximum Length: 240

  Description of the production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies the production line.
• ProductionLineName: string
  Maximum Length: 120

  Name of the production line.

{
    "type":"object",
    "properties":{
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NumberOfLineOperations":{
            "type":"integer",
            "description":"Identifies the number of operations on a production line.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "LineRate":{
            "type":"number",
            "description":"Hourly rate at which production should progress on the line.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AvailabilityCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the available calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductionLineCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the production line.",
            "nullable":false
        },
        "ProductionLineDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the production line.",
            "nullable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AvailabilityCalendarCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the availability calendar.
• AvailabilityCalendarId: integer (int64)
  Value that uniquely identifies the available calendar.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• LineRate: number
  Hourly rate at which production should progress on the line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfLineOperations: integer (int32)
  Identifies the number of operations on a production line.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ProductionLineCode: string
  Maximum Length: 30

  Code that identifies the production line.
• ProductionLineDescription: string
  Maximum Length: 240

  Description of the production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies the production line.
• ProductionLineName: string
  Maximum Length: 120

  Name of the production line.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfLineOperations":{
            "type":"integer",
            "description":"Identifies the number of operations on a production line.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineRate":{
            "type":"number",
            "description":"Hourly rate at which production should progress on the line.",
            "nullable":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
        },
        "ProductionLineCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductionLineDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the production line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailabilityCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the available calendar.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "AvailabilityCalendarCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the availability calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "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