Jump to

• Request
• Response

Create a serial transaction

post

/fscmRestApi/resources/11.13.18.05/productionReports/{ProductionReportId}/child/operationTransactions/{ReportOperationId}/child/transactionSerials

Request

Path Parameters

• ProductionReportId(required): integer(int64)
  Value that uniquely identifies the production report. The application generates this value.
• ReportOperationId(required): integer(int64)
  Value that uniquely identifies the operation transaction. The application generates this value.

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

• errorMessages: array Error Messages
  Title: Error Messages

  The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.
• FromSerialNumber(required): string
  Maximum Length: 80

  Number that identifies the starting serial of either contract manufacturing finished goods item that is generated or the Original Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.
• ReportLotId: integer (int64)
  Value that uniquely identifies the lot transaction reported for an operation or material transaction. The application generates this value.
• ReportOperationMaterialId: integer (int64)
  Value that uniquely identifies the transaction reported for an operation or material transaction. The application generates this value.
• ReportSerialId(required): integer (int64)
  Value that uniquely identifies the serial transaction reported for an operation or material transaction. The application generates this value.
• ToSerialNumber(required): string
  Maximum Length: 80

  Number that identifies the ending serial of either contract manufacturing finished goods item that is generated or the Origninal Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.

{
    "required":[
        "FromSerialNumber",
        "ReportSerialId",
        "ToSerialNumber"
    ],
    "type":"object",
    "properties":{
        "ReportLotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReportOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "errorMessages":{
            "title":"Error Messages",
            "type":"array",
            "description":"The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.",
            "items":{
                "$ref":"#/components/schemas/productionReports-operationTransactions-transactionSerials-errorMessages-item-post-request"
            }
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the starting serial of either contract manufacturing finished goods item that is generated or the Original Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.",
            "nullable":false,
            "x-queryable":false
        },
        "ReportSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the serial transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the ending serial of either contract manufacturing finished goods item that is generated or the Origninal Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : Error Messages

Type: array

Title: Error Messages

The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.

Show Source

• Array of: object productionReports-operationTransactions-transactionSerials-errorMessages-item-post-request

{
    "title":"Error Messages",
    "type":"array",
    "description":"The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.",
    "items":{
        "$ref":"#/components/schemas/productionReports-operationTransactions-transactionSerials-errorMessages-item-post-request"
    }
}

Nested Schema : productionReports-operationTransactions-transactionSerials-errorMessages-item-post-request

Type: object

Show Source

• MessageId: integer (int64)
  Value that uniquely identifies the error message that occurs at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports. This is a system-generated value.
• MessageText: string
  Maximum Length: 1200

  Text of the error message for an error that occurred at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports.
• ProcessingEntityId: string
  Maximum Length: 30

  Value that uniquely identifies the entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions at which the error occurred.

{
    "type":"object",
    "properties":{
        "ProcessingEntityId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions at which the error occurred.",
            "nullable":false
        },
        "MessageText":{
            "maxLength":1200,
            "type":"string",
            "description":"Text of the error message for an error that occurred at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the error message that occurs at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports. This is a system-generated value.",
            "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 : productionReports-operationTransactions-transactionSerials-item-response

Type: object

Show Source

• AssemblySerialNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the serial of the contract manufacturing finished goods item to which the original equipment manufacturer (OEM) supplied component is being issued.
• errorMessages: array Error Messages
  Title: Error Messages

  The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.
• FromSerialNumber: string
  Maximum Length: 80

  Number that identifies the starting serial of either contract manufacturing finished goods item that is generated or the Original Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReportLotId: integer (int64)
  Value that uniquely identifies the lot transaction reported for an operation or material transaction. The application generates this value.
• ReportOperationMaterialId: integer (int64)
  Value that uniquely identifies the transaction reported for an operation or material transaction. The application generates this value.
• ReportSerialId: integer (int64)
  Value that uniquely identifies the serial transaction reported for an operation or material transaction. The application generates this value.
• ToSerialNumber: string
  Maximum Length: 80

  Number that identifies the ending serial of either contract manufacturing finished goods item that is generated or the Origninal Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.

{
    "type":"object",
    "properties":{
        "ReportLotId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReportOperationMaterialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "errorMessages":{
            "title":"Error Messages",
            "type":"array",
            "description":"The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.",
            "items":{
                "$ref":"#/components/schemas/productionReports-operationTransactions-transactionSerials-errorMessages-item-response"
            }
        },
        "AssemblySerialNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the serial of the contract manufacturing finished goods item to which the original equipment manufacturer (OEM) supplied component is being issued.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FromSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the starting serial of either contract manufacturing finished goods item that is generated or the Original Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.",
            "nullable":false,
            "x-queryable":false
        },
        "ToSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the ending serial of either contract manufacturing finished goods item that is generated or the Origninal Equipment Manufacturer (OEM) supplied component that is being issued at a particular operation.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReportSerialId":{
            "type":"integer",
            "description":"Value that uniquely identifies the serial transaction reported for an operation or material transaction. The application generates this value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Error Messages

Type: array

Title: Error Messages

The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.

Show Source

• Array of: object productionReports-operationTransactions-transactionSerials-errorMessages-item-response

{
    "title":"Error Messages",
    "type":"array",
    "description":"The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.",
    "items":{
        "$ref":"#/components/schemas/productionReports-operationTransactions-transactionSerials-errorMessages-item-response"
    }
}

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 : productionReports-operationTransactions-transactionSerials-errorMessages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageId: integer (int64)
  Value that uniquely identifies the error message that occurs at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports. This is a system-generated value.
• MessageText: string
  Maximum Length: 1200

  Text of the error message for an error that occurred at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports.
• ProcessingEntityId: string
  Maximum Length: 30

  Value that uniquely identifies the entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions at which the error occurred.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessingEntityId":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions at which the error occurred.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":1200,
            "type":"string",
            "description":"Text of the error message for an error that occurred at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports.",
            "nullable":true,
            "x-queryable":false
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the error message that occurs at various entities like production reports, operation transactions, material transactions, lot transactions, and serial transactions while processing the production reports. This is a system-generated value.",
            "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."
        }
    }
}

Links

errorMessages

Operation: /fscmRestApi/resources/11.13.18.05/productionReports/{ProductionReportId}/child/operationTransactions/{ReportOperationId}/child/transactionSerials/{ReportSerialId}/child/errorMessages

Parameters:

• ProductionReportId: $request.path.ProductionReportId
• ReportOperationId: $request.path.ReportOperationId
• ReportSerialId4: $request.path.ReportSerialId4

The Error Messages resource manages the errors that occur while creating operation and material transactions for a contract manufacturing work order.

Back to Top