Jump to

• Request
• Response
• Examples

Update one sample

patch

/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/Sample/{SampleId}

Request

Path Parameters

• IpEventId(required): integer
  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=
• SampleId(required): number
  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: 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

• INVSerialNumber: string
  List of values for the inventory serial number that's work in process.
• IpEventId: integer (int64)
  Value that uniquely identifies the event that inspects this sample.
• OriginalDisposition: string
  Maximum Length: 20

  Original disposition for the sample to inspect.
• Quantity: number
  Sample quantity.
• SampleDisposition: array Sample Dispositions
  Title: Sample Dispositions

  The Sample Dispositions resource is used to view, create, or modify sample item dispositions.
• SampleId: integer (int64)
  Value that uniquely identifies the sample to inspect.
• SampleNumber: string
  Maximum Length: 80

  Number that identifies the sample being inspected for a nonserial item.
• SerialNumber: string
  Maximum Length: 80

  Number that identifies the serial being inspected.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure to use for the sample to inspect.
• WIPSerialNumber: string
  List of values for the serial number that's work in process.
• WoOperationTransactionId: integer (int64)
  Value that uniquely identifies the transaction for the work order operation.

{
    "type":"object",
    "properties":{
        "INVSerialNumber":{
            "type":"string",
            "description":"List of values for the inventory serial number that's work in process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event that inspects this sample.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OriginalDisposition":{
            "maxLength":20,
            "type":"string",
            "description":"Original disposition for the sample to inspect.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity.",
            "nullable":true
        },
        "SampleDisposition":{
            "title":"Sample Dispositions",
            "type":"array",
            "description":"The Sample Dispositions resource is used to view, create, or modify sample item dispositions.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-item-patch-request"
            }
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample to inspect.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SampleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the sample being inspected for a nonserial item.",
            "nullable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial being inspected.",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the sample to inspect.",
            "nullable":true
        },
        "WIPSerialNumber":{
            "type":"string",
            "description":"List of values for the serial number that's work in process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WoOperationTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction for the work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Sample Dispositions

Type: array

Title: Sample Dispositions

The Sample Dispositions resource is used to view, create, or modify sample item dispositions.

Show Source

• Array of: object schema

{
    "title":"Sample Dispositions",
    "type":"array",
    "description":"The Sample Dispositions resource is used to view, create, or modify sample item dispositions.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Disposition: string
  Maximum Length: 30

  Result of the inspection disposition. Values include ACCEPT or REJECT.
• IpEventDispositionId: integer (int64)
  Value that uniquely identifies the inspection event disposition where this sample event occurred.
• IpEventId(required): integer (int64)
  Value that uniquely identifies the inspection plan event.
• Quantity: number
  Sample quantity. If the inspection inspects a serial, then Quantity is 1.
• SampleEventDispositionId: integer (int64)
  Value that uniquely identifies the event sample disposition.
• SampleId(required): integer (int64)
  Value that uniquely identifies the sample that you're recording for the disposition.
• SampleResult: array Sample Results
  Title: Sample Results

  The Sample Results resource is used to view, create, or modify the sample results for an item.
• Status: string
  Maximum Length: 20

  Sample status. Valid values include PENDING or COMPLETE.

{
    "required":[
        "IpEventId",
        "SampleId"
    ],
    "type":"object",
    "properties":{
        "Disposition":{
            "maxLength":30,
            "type":"string",
            "description":"Result of the inspection disposition. Values include ACCEPT or REJECT.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DispositionUi"
                ]
            }
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition where this sample event occurred.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity. If the inspection inspects a serial, then Quantity is 1.",
            "nullable":true,
            "x-queryable":false
        },
        "SampleEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event sample disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample that you're recording for the disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SampleResult":{
            "title":"Sample Results",
            "type":"array",
            "description":"The Sample Results resource is used to view, create, or modify the sample results for an item.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-patch-request"
            }
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true
        }
    }
}

Nested Schema : Sample Results

Type: array

Title: Sample Results

The Sample Results resource is used to view, create, or modify the sample results for an item.

Show Source

• Array of: object schema

{
    "title":"Sample Results",
    "type":"array",
    "description":"The Sample Results resource is used to view, create, or modify the sample results for an item.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Attachments: array Result Attachments
  Title: Result Attachments

  The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.
• CharacteristicId(required): integer (int64)
  Value that uniquely identifies the characteristic that this event is inspecting in the sample.
• CharacteristicName: string
  Name that identifies the characteristic that this event is inspecting in the sample.
• Comments: string
  Maximum Length: 4000

  Comments that the user enters during inspection.
• DataType: string
  Maximum Length: 255

  Name of the type of data for the characteristic that the application is inspecting.
• DFF: array DFF
• Disposition: string
  Inspection disposition result. Valid values include ACCEPT or REJECT.
• Evaluation: string
  Maximum Length: 80

  Value that indicates whether the disposition evaluates the result.
• GaugeAssetGroup: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetGroupId: integer (int64)
  Value that uniquely identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetInstance: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset used to collect the inspection result value.
• GaugeAssetInstanceId: integer (int64)
  Value that uniquely identifies the gauge asset used to collect the inspection result value.
• GaugeResource: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource used to collect the inspection result value.
• GaugeResourceId: integer (int64)
  Value that uniquely identifies the gauge resource used to collect the inspection result value.
• GaugeResourceInstance: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource instance used to collect the inspection result value.
• GaugeResourceInstanceId: integer (int64)
  Value that uniquely identifies the gauge resource instance used to collect the inspection result value.
• InSpecification: string
  Describes whether the result remained within specifications.
• InspectionDate(required): string (date-time)
  Date and time that this event collected this result.
• IpEventId(required): integer (int64)
  Value that uniquely identifies the inspection event that collected the result.
• OptionalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute doesn't have a default value.
• Quantity: number
  Quantity of samples that this event inspected.
• ResultEvaluation: array Result Evaluations
  Title: Result Evaluations

  The Result Evaluations resource is used to view, create, or modify the evaluation results.
• ResultValueChar: string
  Maximum Length: 80

  Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar.
• ResultValueCharNonValidated: string
  Maximum Length: 80

  Value that identifies the results of the character data type that the application doesn't validate.
• ResultValueDate: string (date-time)
  Date when this event entered the sample inspection result.
• ResultValueNumber: number
  Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.
• SampleId(required): integer (int64)
  Value that uniquely identifies the sample results that this event is entering.
• SampleResultId: integer (int64)
  Value that uniquely identifies the result of the sample inspection.
• UOMCode: string
  Maximum Length: 3

  Unit of measurement for the quantity of samples that this event inspects.
• UserSequence: integer (int32)
  User sequence.

{
    "required":[
        "CharacteristicId",
        "InspectionDate",
        "IpEventId",
        "SampleId"
    ],
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Result Attachments",
            "type":"array",
            "description":"The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-patch-request"
            }
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic that this event is inspecting in the sample.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CharacteristicName":{
            "type":"string",
            "description":"Name that identifies the characteristic that this event is inspecting in the sample.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments that the user enters during inspection.",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "DataType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of data for the characteristic that the application is inspecting.",
            "nullable":true
        },
        "Disposition":{
            "type":"string",
            "description":"Inspection disposition result. Valid values include ACCEPT or REJECT.",
            "nullable":true,
            "x-queryable":false
        },
        "Evaluation":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":true,
            "x-queryable":false
        },
        "GaugeAssetGroup":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset group used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "GaugeAssetInstance":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "GaugeAssetGroupId"
                ]
            }
        },
        "GaugeResource":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "GaugeResourceInstance":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource instance used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource instance used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "GaugeResourceId"
                ]
            }
        },
        "InSpecification":{
            "type":"string",
            "description":"Describes whether the result remained within specifications.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionDate":{
            "type":"string",
            "description":"Date and time that this event collected this result.",
            "format":"date-time",
            "nullable":false
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that collected the result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute doesn't have a default value.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of samples that this event inspected.",
            "nullable":true
        },
        "ResultEvaluation":{
            "title":"Result Evaluations",
            "type":"array",
            "description":"The Result Evaluations resource is used to view, create, or modify the evaluation results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-patch-request"
            }
        },
        "ResultValueChar":{
            "maxLength":80,
            "type":"string",
            "description":"Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResultValueCharNonValidated":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the results of the character data type that the application doesn't validate.",
            "nullable":true
        },
        "ResultValueDate":{
            "type":"string",
            "description":"Date when this event entered the sample inspection result.",
            "format":"date-time",
            "nullable":true
        },
        "ResultValueNumber":{
            "type":"number",
            "description":"Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.",
            "nullable":true
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample results that this event is entering.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SampleResultId":{
            "type":"integer",
            "description":"Value that uniquely identifies the result of the sample inspection.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measurement for the quantity of samples that this event inspects.",
            "nullable":true
        },
        "UserSequence":{
            "type":"integer",
            "description":"User sequence.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Nested Schema : Result Attachments

Type: array

Title: Result Attachments

The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-patch-request

{
    "title":"Result Attachments",
    "type":"array",
    "description":"The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-patch-request"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Result Evaluations

Type: array

Title: Result Evaluations

The Result Evaluations resource is used to view, create, or modify the evaluation results.

Show Source

• Array of: object schema

{
    "title":"Result Evaluations",
    "type":"array",
    "description":"The Result Evaluations resource is used to view, create, or modify the evaluation results.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-patch-request"
    }
}

Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is true.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path to the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error status.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL to the attached file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform Resource Identifier (URI) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL to the attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path to the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL to the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Identifier (URI) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL to the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• SampleResultId: integer (int64)

{
    "type":"object",
    "properties":{
        "SampleResultId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AdditionalChar: string
  Maximum Length: 1

  Value that indicates whether the inspection plan includes the characteristic.
• Evaluation: string
  Maximum Length: 1

  Value that indicates whether the disposition evaluates the result.
• InSpecification: string
  Maximum Length: 1

  Value that indicates whether the result meets the specifications.
• IpEventDispositionId: integer (int64)
  Value that uniquely identifies the inspection event disposition.
• IpEventId: integer (int64)
  Value that uniquely identifies the inspection event that entered the results.
• ResultEvaluationId: integer (int64)
  Value that uniquely identifies the result evaluation.
• SampleResultId: integer (int64)
  Value that uniquely identifies the sample result that this event uses to determine the evaluation.

{
    "type":"object",
    "properties":{
        "AdditionalChar":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the inspection plan includes the characteristic.",
            "nullable":true
        },
        "Evaluation":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":true
        },
        "InSpecification":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the result meets the specifications.",
            "nullable":true
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that entered the results.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ResultEvaluationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the result evaluation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SampleResultId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample result that this event uses to determine the evaluation.",
            "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 : inspectionEvents-Sample-item-response

Type: object

Show Source

• Disposition: string
  Read Only: true

  Maximum Length: 30

  Result of the inspection disposition. Values include ACCEPT or REJECT.
• DispositionMeaning: string
  Read Only: true

  Maximum Length: 255

  Indicates the disposition of the inspection. Valid values are: Accepted, Completed, In Progress, Pending, and Rejected.
• INVSerialNumber: string
  List of values for the inventory serial number that's work in process.
• IpEventId: integer (int64)
  Value that uniquely identifies the event that inspects this sample.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.
• OriginalDisposition: string
  Maximum Length: 20

  Original disposition for the sample to inspect.
• Quantity: number
  Sample quantity.
• SampleDisposition: array Sample Dispositions
  Title: Sample Dispositions

  The Sample Dispositions resource is used to view, create, or modify sample item dispositions.
• SampleId: integer (int64)
  Value that uniquely identifies the sample to inspect.
• SampleNumber: string
  Maximum Length: 80

  Number that identifies the sample being inspected for a nonserial item.
• SerialNumber: string
  Maximum Length: 80

  Number that identifies the serial being inspected.
• Status: string
  Read Only: true

  Maximum Length: 20

  Sample status. Valid values include PENDING or COMPLETE.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 255

  Sample status. Valid values include PENDING or COMPLETE.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for quantity per sample.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure to use for the sample to inspect.
• WIPSerialNumber: string
  List of values for the serial number that's work in process.
• WoOperationTransactionId: integer (int64)
  Value that uniquely identifies the transaction for the work order operation.

{
    "type":"object",
    "properties":{
        "Disposition":{
            "maxLength":30,
            "type":"string",
            "description":"Result of the inspection disposition. Values include ACCEPT or REJECT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DispositionMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the disposition of the inspection. Valid values are: Accepted, Completed, In Progress, Pending, and Rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "INVSerialNumber":{
            "type":"string",
            "description":"List of values for the inventory serial number that's work in process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event that inspects this sample.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OriginalDisposition":{
            "maxLength":20,
            "type":"string",
            "description":"Original disposition for the sample to inspect.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "SampleDisposition":{
            "title":"Sample Dispositions",
            "type":"array",
            "description":"The Sample Dispositions resource is used to view, create, or modify sample item dispositions.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-item-response"
            }
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample to inspect.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SampleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the sample being inspected for a nonserial item.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the serial being inspected.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the sample to inspect.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for quantity per sample.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WIPSerialNumber":{
            "type":"string",
            "description":"List of values for the serial number that's work in process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WoOperationTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction for the work order operation.",
            "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"
            }
        }
    }
}

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 : Sample Dispositions

Type: array

Title: Sample Dispositions

The Sample Dispositions resource is used to view, create, or modify sample item dispositions.

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-item-response

{
    "title":"Sample Dispositions",
    "type":"array",
    "description":"The Sample Dispositions resource is used to view, create, or modify sample item dispositions.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-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 : inspectionEvents-Sample-SampleDisposition-item-response

Type: object

Show Source

• Disposition: string
  Maximum Length: 30

  Result of the inspection disposition. Values include ACCEPT or REJECT.
• IpEventDispositionId: integer (int64)
  Value that uniquely identifies the inspection event disposition where this sample event occurred.
• IpEventId: integer (int64)
  Value that uniquely identifies the inspection plan event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.
• Quantity: number
  Sample quantity. If the inspection inspects a serial, then Quantity is 1.
• SampleEventDispositionId: integer (int64)
  Value that uniquely identifies the event sample disposition.
• SampleId: integer (int64)
  Value that uniquely identifies the sample that you're recording for the disposition.
• SampleResult: array Sample Results
  Title: Sample Results

  The Sample Results resource is used to view, create, or modify the sample results for an item.
• Status: string
  Maximum Length: 20

  Sample status. Valid values include PENDING or COMPLETE.

{
    "type":"object",
    "properties":{
        "Disposition":{
            "maxLength":30,
            "type":"string",
            "description":"Result of the inspection disposition. Values include ACCEPT or REJECT.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DispositionUi"
                ]
            },
            "x-queryable":true
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition where this sample event occurred.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity. If the inspection inspects a serial, then Quantity is 1.",
            "nullable":true,
            "x-queryable":false
        },
        "SampleEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event sample disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample that you're recording for the disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SampleResult":{
            "title":"Sample Results",
            "type":"array",
            "description":"The Sample Results resource is used to view, create, or modify the sample results for an item.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-response"
            }
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Sample Results

Type: array

Title: Sample Results

The Sample Results resource is used to view, create, or modify the sample results for an item.

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-item-response

{
    "title":"Sample Results",
    "type":"array",
    "description":"The Sample Results resource is used to view, create, or modify the sample results for an item.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-response"
    }
}

Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-item-response

Type: object

Show Source

• Attachments: array Result Attachments
  Title: Result Attachments

  The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.
• CharacteristicId: integer (int64)
  Value that uniquely identifies the characteristic that this event is inspecting in the sample.
• CharacteristicName: string
  Name that identifies the characteristic that this event is inspecting in the sample.
• Comments: string
  Maximum Length: 4000

  Comments that the user enters during inspection.
• DataType: string
  Maximum Length: 255

  Name of the type of data for the characteristic that the application is inspecting.
• DFF: array DFF
• Disposition: string
  Inspection disposition result. Valid values include ACCEPT or REJECT.
• Evaluation: string
  Maximum Length: 80

  Value that indicates whether the disposition evaluates the result.
• GaugeAssetGroup: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetGroupId: integer (int64)
  Value that uniquely identifies the gauge asset group used to collect the inspection result value.
• GaugeAssetInstance: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge asset used to collect the inspection result value.
• GaugeAssetInstanceId: integer (int64)
  Value that uniquely identifies the gauge asset used to collect the inspection result value.
• GaugeResource: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource used to collect the inspection result value.
• GaugeResourceId: integer (int64)
  Value that uniquely identifies the gauge resource used to collect the inspection result value.
• GaugeResourceInstance: string
  Maximum Length: 255

  Alphanumeric value that identifies the gauge resource instance used to collect the inspection result value.
• GaugeResourceInstanceId: integer (int64)
  Value that uniquely identifies the gauge resource instance used to collect the inspection result value.
• InSpecification: string
  Describes whether the result remained within specifications.
• InspectionDate: string (date-time)
  Date and time that this event collected this result.
• IpEventId: integer (int64)
  Value that uniquely identifies the inspection event that collected the result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.
• OptionalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute doesn't have a default value.
• Quantity: number
  Quantity of samples that this event inspected.
• ResultEvaluation: array Result Evaluations
  Title: Result Evaluations

  The Result Evaluations resource is used to view, create, or modify the evaluation results.
• ResultValueChar: string
  Maximum Length: 80

  Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar.
• ResultValueCharNonValidated: string
  Maximum Length: 80

  Value that identifies the results of the character data type that the application doesn't validate.
• ResultValueDate: string (date-time)
  Date when this event entered the sample inspection result.
• ResultValueNumber: number
  Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.
• SampleId: integer (int64)
  Value that uniquely identifies the sample results that this event is entering.
• SampleResultId: integer (int64)
  Value that uniquely identifies the result of the sample inspection.
• UOMCode: string
  Maximum Length: 3

  Unit of measurement for the quantity of samples that this event inspects.
• UserSequence: integer (int32)
  User sequence.

{
    "type":"object",
    "properties":{
        "Attachments":{
            "title":"Result Attachments",
            "type":"array",
            "description":"The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response"
            }
        },
        "CharacteristicId":{
            "type":"integer",
            "description":"Value that uniquely identifies the characteristic that this event is inspecting in the sample.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CharacteristicName":{
            "type":"string",
            "description":"Name that identifies the characteristic that this event is inspecting in the sample.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments that the user enters during inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DataType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of data for the characteristic that the application is inspecting.",
            "nullable":true,
            "x-queryable":true
        },
        "Disposition":{
            "type":"string",
            "description":"Inspection disposition result. Valid values include ACCEPT or REJECT.",
            "nullable":true,
            "x-queryable":false
        },
        "Evaluation":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":true,
            "x-queryable":false
        },
        "GaugeAssetGroup":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset group used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset group used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "GaugeAssetInstance":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge asset used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeAssetInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge asset used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "GaugeAssetGroupId"
                ]
            }
        },
        "GaugeResource":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "GaugeResourceInstance":{
            "maxLength":255,
            "type":"string",
            "description":"Alphanumeric value that identifies the gauge resource instance used to collect the inspection result value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "GaugeResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the gauge resource instance used to collect the inspection result value.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "GaugeResourceId"
                ]
            }
        },
        "InSpecification":{
            "type":"string",
            "description":"Describes whether the result remained within specifications.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionDate":{
            "type":"string",
            "description":"Date and time that this event collected this result.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that collected the result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the entry of result value is optional during an inspection. If false, then the entry of result value is mandatory during an inspection. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of samples that this event inspected.",
            "nullable":true,
            "x-queryable":true
        },
        "ResultEvaluation":{
            "title":"Result Evaluations",
            "type":"array",
            "description":"The Result Evaluations resource is used to view, create, or modify the evaluation results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response"
            }
        },
        "ResultValueChar":{
            "maxLength":80,
            "type":"string",
            "description":"Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResultValueCharNonValidated":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the results of the character data type that the application doesn't validate.",
            "nullable":true,
            "x-queryable":true
        },
        "ResultValueDate":{
            "type":"string",
            "description":"Date when this event entered the sample inspection result.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ResultValueNumber":{
            "type":"number",
            "description":"Inspection result represented as a number. If this resource can represent this result as a number, then it uses ResultValueNumber.",
            "nullable":true,
            "x-queryable":true
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample results that this event is entering.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SampleResultId":{
            "type":"integer",
            "description":"Value that uniquely identifies the result of the sample inspection.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measurement for the quantity of samples that this event inspects.",
            "nullable":true,
            "x-queryable":true
        },
        "UserSequence":{
            "type":"integer",
            "description":"User sequence.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Result Attachments

Type: array

Title: Result Attachments

The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response

{
    "title":"Result Attachments",
    "type":"array",
    "description":"The Event Attachments resource is used to view, create, or modify the attachments for the inspection events.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Result Evaluations

Type: array

Title: Result Evaluations

The Result Evaluations resource is used to view, create, or modify the evaluation results.

Show Source

• Array of: object inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response

{
    "title":"Result Evaluations",
    "type":"array",
    "description":"The Result Evaluations resource is used to view, create, or modify the evaluation results.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response"
    }
}

Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is true.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the application created the attachment.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path to the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error status.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL to the attached file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The Base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Uniform Resource Identifier (URI) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL to the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment. If false, then not shared. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the application created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path to the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error status.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL to the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The Base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Login of the user who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Identifier (URI) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL to the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : inspectionEvents-Sample-SampleDisposition-SampleResult-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SampleResultId: integer (int64)

{
    "type":"object",
    "properties":{
        "SampleResultId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response

Type: object

Show Source

• AdditionalChar: string
  Maximum Length: 1

  Value that indicates whether the inspection plan includes the characteristic.
• Evaluation: string
  Maximum Length: 1

  Value that indicates whether the disposition evaluates the result.
• InSpecification: string
  Maximum Length: 1

  Value that indicates whether the result meets the specifications.
• IpEventDispositionId: integer (int64)
  Value that uniquely identifies the inspection event disposition.
• IpEventId: integer (int64)
  Value that uniquely identifies the inspection event that entered the results.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.
• ResultEvaluationId: integer (int64)
  Value that uniquely identifies the result evaluation.
• SampleResultId: integer (int64)
  Value that uniquely identifies the sample result that this event uses to determine the evaluation.

{
    "type":"object",
    "properties":{
        "AdditionalChar":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the inspection plan includes the characteristic.",
            "nullable":true,
            "x-queryable":true
        },
        "Evaluation":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":true,
            "x-queryable":true
        },
        "InSpecification":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the result meets the specifications.",
            "nullable":true,
            "x-queryable":true
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that entered the results.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version. You can use this attribute to lock the object. The Inspection Events resource increments this value every time it updates the row. It compares this number at the start and end of the transaction to determine whether another session updated the same row during the inspection.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ResultEvaluationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the result evaluation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SampleResultId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample result that this event uses to determine the evaluation.",
            "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"
            }
        }
    }
}

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

SampleDisposition

Operation: /fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/Sample/{SampleId}/child/SampleDisposition

Parameters:

• IpEventId: $request.path.IpEventId
• SampleId: $request.path.SampleId

The Sample Dispositions resource is used to view, create, or modify sample item dispositions.

Back to Top

Examples

This example describes how to update the serial number of an inventory or work-in-process inspection performed against a serial controlled item..

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inspectionEvents/IpEventId/child/Sample/SampleId"

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.

{
"SerialNumber": "1007"
}

Example Response Body

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

{
    "IpEventId": 300100612704689,
    "ObjectVersionNumber": 3,
    "OriginalDisposition": null,
    "Quantity": 1,
    "SampleId": 300100612704691,
    "SampleNumber": null,
    "SerialNumber": "1007",
    "UOMCode": null,
    "WoOperationTransactionId": null,
    "WIPSerialNumber": null,
    "INVSerialNumber": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689/child/Sample/300100612704691",
            "name": "Sample",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689/child/Sample/300100612704691",
            "name": "Sample",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689",
            "name": "inspectionEvents",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689/child/Sample/300100612704691/lov/INVSerialNumberLOV",
            "name": "INVSerialNumberLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689/child/Sample/300100612704691/lov/WIPSerialNumberLOV",
            "name": "WIPSerialNumberLOV",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/inspectionEvents/300100612704689/child/Sample/300100612704691/child/SampleDisposition",
            "name": "SampleDisposition",
            "kind": "collection"
        }
    ]
}

Back to Top