Jump to

• Request
• Response
• Examples

Create all production lines

post

/fscmRestApi/resources/11.13.18.05/productionLines

Request

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.
• Upsert-Mode: string
  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

• InactiveDate: string (date)
  Title: Inactive On

  Date when the production line is inactive.
• IntermediateOperationComplFlag: boolean
  Maximum Length: 1

  Indicates whether completion for a flow schedule on this production line needs to be completed at the operation level.
• LineRate: number
  Title: Rate

  Rate, number of units, of the line at which production should progress on an hourly basis.
• NumberOfLineOperations: number
  Expected number of operations on the production line.
• ObjectVersionNumber: integer (int32)
  Number that indicates the object version that the production line references.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId(required): integer (int64)
  Value that uniquely identifies the inventory organization where production lne is created. It's a primary key that the application generates when it creates the inventory organization.
• PlLineOperation: array PlLineOperations
  Title: PlLineOperations

  Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations
• ProductionLineCode(required): string
  Title: Code

  Maximum Length: 30

  Code that identifies the production line.
• ProductionLineDescription: string
  Title: Description

  Maximum Length: 240

  Description of the production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies the production line. It's a primary key that the application generates when it creates the production line.
• ProductionLineName(required): string
  Title: Name

  Maximum Length: 120

  Name of the production line.

{
    "required":[
        "OrganizationId",
        "ProductionLineCode",
        "ProductionLineName"
    ],
    "type":"object",
    "properties":{
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the production line is inactive.",
            "format":"date",
            "nullable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line. It's a primary key that the application generates when it creates the production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "NumberOfLineOperations":{
            "type":"number",
            "description":"Expected number of operations on the production line.",
            "nullable":true
        },
        "IntermediateOperationComplFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether completion for a flow schedule on this production line needs to be completed at the operation level.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that indicates the object version that the production line references.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "LineRate":{
            "title":"Rate",
            "type":"number",
            "description":"Rate, number of units, of the line at which production should progress on an hourly basis.",
            "nullable":true
        },
        "PlLineOperation":{
            "title":"PlLineOperations",
            "type":"array",
            "description":"Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations",
            "items":{
                "$ref":"#/components/schemas/productionLines-PlLineOperation-item-post-request"
            }
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductionLineCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the production line.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where production lne is created. It's a primary key that the application generates when it creates the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode"
                ]
            }
        },
        "ProductionLineName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":false
        },
        "ProductionLineDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the production line.",
            "nullable":true
        }
    }
}

Nested Schema : PlLineOperations

Type: array

Title: PlLineOperations

Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations

Show Source

• Array of: object productionLines-PlLineOperation-item-post-request

{
    "title":"PlLineOperations",
    "type":"array",
    "description":"Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations",
    "items":{
        "$ref":"#/components/schemas/productionLines-PlLineOperation-item-post-request"
    }
}

Nested Schema : productionLines-PlLineOperation-item-post-request

Type: object

Show Source

• LineOperationSequenceNumber: number
  Value that represents the line operation sequence on the production line.
• ObjectVersionNumber: integer (int32)
  Number that indicates the object version the line operation references.
• PlLineOperationId: integer (int64)
  Value that uniquely identifies a line operation on a production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies a production line.
• WorkstationCode: string
  Maximum Length: 255

  Abbreviation that identifies the workstation associated with the line operation.
• WorkstationId: integer (int64)
  Value that uniquely identifies the work station.
• WorkstationName: string
  Maximum Length: 255

  Name of the workstation associated with the line operation.

{
    "type":"object",
    "properties":{
        "PlLineOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies a line operation on a production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies a production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkstationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the workstation associated with the line operation.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that indicates the object version the line operation references.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "LineOperationSequenceNumber":{
            "type":"number",
            "description":"Value that represents the line operation sequence on the production line.",
            "nullable":false
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work station.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkstationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the workstation associated with the line operation.",
            "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:
  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 : productionLines-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the record was created.
• InactiveDate: string (date)
  Title: Inactive On

  Date when the production line is inactive.
• IntermediateOperationComplFlag: boolean
  Maximum Length: 1

  Indicates whether completion for a flow schedule on this production line needs to be completed at the operation level.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  Session login associated with the user who most recently updated the record.
• LineRate: number
  Title: Rate

  Rate, number of units, of the line at which production should progress on an hourly basis.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfLineOperations: number
  Expected number of operations on the production line.
• ObjectVersionNumber: integer (int32)
  Number that indicates the object version that the production line references.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization where production lne is created. It's a primary key that the application generates when it creates the inventory organization.
• PlLineOperation: array PlLineOperations
  Title: PlLineOperations

  Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations
• ProductionLineCode: string
  Title: Code

  Maximum Length: 30

  Code that identifies the production line.
• ProductionLineDescription: string
  Title: Description

  Maximum Length: 240

  Description of the production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies the production line. It's a primary key that the application generates when it creates the production line.
• ProductionLineName: string
  Title: Name

  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
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the production line is inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfLineOperations":{
            "type":"number",
            "description":"Expected number of operations on the production line.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineRate":{
            "title":"Rate",
            "type":"number",
            "description":"Rate, number of units, of the line at which production should progress on an hourly basis.",
            "nullable":true,
            "x-queryable":true
        },
        "PlLineOperation":{
            "title":"PlLineOperations",
            "type":"array",
            "description":"Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations",
            "items":{
                "$ref":"#/components/schemas/productionLines-PlLineOperation-item-response"
            }
        },
        "ProductionLineCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where production lne is created. It's a primary key that the application generates when it creates the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode"
                ]
            },
            "x-queryable":true
        },
        "ProductionLineName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductionLineDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the production line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production line. It's a primary key that the application generates when it creates the production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IntermediateOperationComplFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether completion for a flow schedule on this production line needs to be completed at the operation level.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that indicates the object version that the production line references.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated with the user who most recently updated the record.",
            "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 : PlLineOperations

Type: array

Title: PlLineOperations

Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations

Show Source

• Array of: object productionLines-PlLineOperation-item-response

{
    "title":"PlLineOperations",
    "type":"array",
    "description":"Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations",
    "items":{
        "$ref":"#/components/schemas/productionLines-PlLineOperation-item-response"
    }
}

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."
        }
    }
}

Nested Schema : productionLines-PlLineOperation-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  Login of the user who last updated the record.
• LineOperationSequenceNumber: number
  Value that represents the line operation sequence on the production line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number that indicates the object version the line operation references.
• PlLineOperationId: integer (int64)
  Value that uniquely identifies a line operation on a production line.
• ProductionLineId: integer (int64)
  Value that uniquely identifies a production line.
• WorkstationCode: string
  Maximum Length: 255

  Abbreviation that identifies the workstation associated with the line operation.
• WorkstationId: integer (int64)
  Value that uniquely identifies the work station.
• WorkstationName: string
  Maximum Length: 255

  Name of the workstation associated with the line operation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkstationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the workstation associated with the line operation.",
            "nullable":true,
            "x-queryable":true
        },
        "LineOperationSequenceNumber":{
            "type":"number",
            "description":"Value that represents the line operation sequence on the production line.",
            "nullable":false,
            "x-queryable":true
        },
        "PlLineOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies a line operation on a production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies a production line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that indicates the object version the line operation references.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work station.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkstationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the workstation associated with the line operation.",
            "nullable":true,
            "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 record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "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"
    }
}

Links

PlLineOperation

Operation: /fscmRestApi/resources/11.13.18.05/productionLines/{ProductionLineId}/child/PlLineOperation

Parameters:

• ProductionLineId: $request.path.ProductionLineId

Line operation sequences for production line operations are created based on the number of line operations in the production line and allow the association of workstations

Back to Top

Examples

This example describes how to create production lines.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/productionLines"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "ProductionLineCode": "PLW0C52L",
    "OrganizationCode": "SCMDISFM",
    "ProductionLineName": "PLW0C52L",
    "ProductionLineDescription": "Production Line for test 1846215",
    "LineRate": 1
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "ProductionLineId" : 300100674029050,
  "ObjectVersionNumber" : 1,
  "OrganizationId" : 300100622732103,
  "ProductionLineCode" : "PLW0C52L",
  "ProductionLineName" : "PLW0C52L",
  "ProductionLineDescription" : "Production Line for test 1846215",
  "LineRate" : 1,
  "InactiveDate" : null,
  "CreatedBy" : "MFG_QA",
  "CreationDate" : "2024-11-14T09:35:46+00:00",
  "LastUpdatedBy" : "MFG_QA",
  "LastUpdateDate" : "2024-11-14T09:35:46.300+00:00",
  "LastUpdateLogin" : "23E3F143D92C5E0EE063715A060A1595",
  "OrganizationCode" : "SCMDISFM",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/productionLines/300100674029050",
    "name" : "productionLines",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/productionLines/300100674029050",
    "name" : "productionLines",
    "kind" : "item"
  } ]
}

Back to Top