Jump to

• Request
• Response
• Examples

Create serial numbers

post

/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderSerialNumber

Request

Path Parameters

• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.

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

• SerialNumber: string
  Maximum Length: 80

  Serial number that the work order product references.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order that this serial number references. It is a primary key that the application generates when it creates the work order.

{
    "type":"object",
    "properties":{
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Serial number that the work order product references.",
            "nullable":false
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order that this serial number references. It is a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":true,
            "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:
  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 : workOrders-WorkOrderSerialNumber-item-response

Type: object

Show Source

• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item, product, or assembly in the inventory organization.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the operation that references this serial number.
• OperationSequenceNumber: number
  Title: Operation Sequence

  Read Only: true

  Sequence to use when performing the work order operations that reference this serial number.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization.
• SerialNumber: string
  Maximum Length: 80

  Serial number that the work order product references.
• SerialStatus: string
  Read Only: true

  Maximum Length: 30

  This is an internal work execution status for the serial number. A list of accepted values is defined in the lookup type ORA_WIE_SERIAL_STATUS.
• SerialStatusDescription: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description of the status of the serial number.
• StandardOperationCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the operation.
• StandardOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the operation that the work order references. It is a primary key that the application generates when it creates the operation.
• WorkAreaId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
• WorkAreaName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work area.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work center.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order that this serial number references. It is a primary key that the application generates when it creates the work order.
• WorkOrderOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation.
• WorkOrderOperationMaterialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the material for the work order operation. It is a primary key that the application generates when it creates the material for the work order operation.
• WorkOrderProductSerialId: integer (int64)
  Read Only: true

  Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the material for the work order operation. It is a primary key that the application generates when it creates the material for the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the operation that references this serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the operation that the work order references. It is a primary key that the application generates when it creates the operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Serial number that the work order product references.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order that this serial number references. It is a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Sequence to use when performing the work order operations that reference this serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SerialStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"This is an internal work execution status for the serial number. A list of accepted values is defined in the lookup type ORA_WIE_SERIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderProductSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product serial in the work order. It is a primary key that the application generates when it creates the serial number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SerialStatusDescription":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the status of the serial number.",
            "nullable":false,
            "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

Examples

This example describes how to create one serial number for one work order.

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.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/workOrders/WorkOrderId/child/WorkOrderSerialNumber"

For example, the following command creates serial PS5219 in work order 300100113271611:

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

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

{
  "SerialNumber":"PS5219"
}

Example Response Body

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

{
  "OrganizationId": 207,
  "WorkOrderProductSerialId": 300100113268812,
  "WorkOrderId": 300100113271611,
  "WorkOrderOperationMaterialId": 300100113271624,
  "WorkOrderOperationId": null,
  "OperationSequenceNumber": null,
  "OperationName": null,
  "StandardOperationId": null,
  "StandardOperationCode": null,
  "WorkAreaId": null,
  "WorkAreaName": null,
  "WorkCenterId": null,
  "WorkCenterName": null,
  "InventoryItemId": 300100036689383,
  "SerialNumber": "PS5219",
  "SerialStatus": "ASSOCIATED",
  "SerialStatusDescription": null
}

Back to Top