Jump to

• Request
• Response
• Examples

Create one disposition

post

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

Request

Path Parameters

• IpEventId(required): integer
  Value that uniquely identifies the inspection event.
• SampleId(required): number
  Value that uniquely identifies the sample to inspect.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 are recording for the disposition.
• SampleResult: array Sample Results
  Title: Sample Results

  The Sample Results resource manages 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":{
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true
        },
        "SampleEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event sample disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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
            }
        },
        "Disposition":{
            "maxLength":30,
            "type":"string",
            "description":"Result of the inspection disposition. Values include ACCEPT or REJECT.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DispositionUi"
                ]
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity. If the inspection inspects a serial, then Quantity is 1.",
            "nullable":true,
            "x-queryable":false
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SampleResult":{
            "title":"Sample Results",
            "type":"array",
            "description":"The Sample Results resource manages the sample results for an item.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-post-request"
            }
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample that you are recording for the disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Sample Results

Type: array

Title: Sample Results

The Sample Results resource manages the sample results for an item.

Show Source

• Array of: object schema

{
    "title":"Sample Results",
    "type":"array",
    "description":"The Sample Results resource manages the sample results for an item.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Attachments: array Result Attachments
  Title: Result Attachments

  The Result Attachments resource manages the attachments for the sample results.
• 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.
• 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.
• 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 does not have a default value.
• Quantity: number
  Quantity of samples that this event inspected.
• ResultEvaluation: array Result Evaluations
  Title: Result Evaluations

  The Result Evaluations resource manages 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 does not 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":{
        "Evaluation":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionDate":{
            "type":"string",
            "description":"Date and time that this event collected this result.",
            "format":"date-time",
            "nullable":false
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments that the user enters during inspection.",
            "nullable":true
        },
        "ResultEvaluation":{
            "title":"Result Evaluations",
            "type":"array",
            "description":"The Result Evaluations resource manages the evaluation results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-post-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
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of samples that this event inspected.",
            "nullable":true
        },
        "ResultValueCharNonValidated":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the results of the character data type that the application does not validate.",
            "nullable":true
        },
        "Attachments":{
            "title":"Result Attachments",
            "type":"array",
            "description":"The Result Attachments resource manages the attachments for the sample results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-post-request"
            }
        },
        "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 does not have a default value.",
            "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "Disposition":{
            "type":"string",
            "description":"Inspection disposition result. Valid values include ACCEPT or REJECT.",
            "nullable":true,
            "x-queryable":false
        },
        "InSpecification":{
            "type":"string",
            "description":"Describes whether the result remained within specifications.",
            "nullable":true,
            "x-queryable":false
        },
        "DataType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of data for the characteristic that the application is inspecting.",
            "nullable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event that collected the result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserSequence":{
            "type":"integer",
            "description":"User sequence.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "CharacteristicName":{
            "type":"string",
            "description":"Name that identifies the characteristic that this event is inspecting in the sample.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResultValueDate":{
            "type":"string",
            "description":"Date when this event entered the sample inspection result.",
            "format":"date-time",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measurement for the quantity of samples that this event inspects.",
            "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
            }
        }
    }
}

Nested Schema : Result Attachments

Type: array

Title: Result Attachments

The Result Attachments resource manages the attachments for the sample results.

Show Source

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

{
    "title":"Result Attachments",
    "type":"array",
    "description":"The Result Attachments resource manages the attachments for the sample results.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-post-request"
    }
}

Nested Schema : Result Evaluations

Type: array

Title: Result Evaluations

The Result Evaluations resource manages the evaluation results.

Show Source

• Array of: object schema

{
    "title":"Result Evaluations",
    "type":"array",
    "description":"The Result Evaluations resource manages the evaluation results.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-post-request"
    }
}

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An 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.
• 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, if any, 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 (Uniform Resource Locator) that locates the attached file.
• 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

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

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) 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 (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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":{
        "Evaluation":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":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
            }
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InSpecification":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the result meets the specifications.",
            "nullable":true
        },
        "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"
            }
        },
        "AdditionalChar":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the inspection plan includes the characteristic.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : 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

  Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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 are recording for the disposition.
• SampleResult: array Sample Results
  Title: Sample Results

  The Sample Results resource manages the sample results for an item.
• Status: string
  Maximum Length: 20

  Sample status. Valid values include PENDING or COMPLETE.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Sample status. Valid values include PENDING or COMPLETE.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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
        },
        "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
        },
        "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
        },
        "Quantity":{
            "type":"number",
            "description":"Sample quantity. If the inspection inspects a serial, then Quantity is 1.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IpEventId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SampleResult":{
            "title":"Sample Results",
            "type":"array",
            "description":"The Sample Results resource manages the sample results for an item.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-item-response"
            }
        },
        "SampleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sample that you are recording for the disposition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Sample Results

Type: array

Title: Sample Results

The Sample Results resource manages 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 manages the sample results for an item.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-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-SampleResult-item-response

Type: object

Show Source

• Attachments: array Result Attachments
  Title: Result Attachments

  The Result Attachments resource manages the attachments for the sample results.
• 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.
• 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.
• 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

  Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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 does not have a default value.
• Quantity: number
  Quantity of samples that this event inspected.
• ResultEvaluation: array Result Evaluations
  Title: Result Evaluations

  The Result Evaluations resource manages 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 does not 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":{
        "Evaluation":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "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
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments that the user enters during inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "ResultEvaluation":{
            "title":"Result Evaluations",
            "type":"array",
            "description":"The Result Evaluations resource manages the evaluation results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-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
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of samples that this event inspected.",
            "nullable":true,
            "x-queryable":true
        },
        "ResultValueCharNonValidated":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the results of the character data type that the application does not validate.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Result Attachments",
            "type":"array",
            "description":"The Result Attachments resource manages the attachments for the sample results.",
            "items":{
                "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response"
            }
        },
        "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 does not have a default value.",
            "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
        },
        "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
        },
        "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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
        },
        "Disposition":{
            "type":"string",
            "description":"Inspection disposition result. Valid values include ACCEPT or REJECT.",
            "nullable":true,
            "x-queryable":false
        },
        "InSpecification":{
            "type":"string",
            "description":"Describes whether the result remained within specifications.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "UserSequence":{
            "type":"integer",
            "description":"User sequence.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "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
        },
        "ResultValueDate":{
            "type":"string",
            "description":"Date when this event entered the sample inspection result.",
            "format":"date-time",
            "nullable":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
        },
        "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
        }
    }
}

Nested Schema : Result Attachments

Type: array

Title: Result Attachments

The Result Attachments resource manages the attachments for the sample results.

Show Source

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

{
    "title":"Result Attachments",
    "type":"array",
    "description":"The Result Attachments resource manages the attachments for the sample results.",
    "items":{
        "$ref":"#/components/schemas/inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Result Evaluations

Type: array

Title: Result Evaluations

The Result Evaluations resource manages 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 manages 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

  An 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, if any, 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 (Uniform Resource Locator) that locates 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.
• 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

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

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates 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":{
        "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
        },
        "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"
            }
        },
        "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
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) 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 (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
        },
        "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
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

  Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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":{
        "Evaluation":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the disposition evaluates the result.",
            "nullable":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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number. You can use this attribute to lock the object. This resource increments this value every time it updates the row. It compares this number at the start and at the 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
        },
        "IpEventDispositionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection event disposition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InSpecification":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the result meets the specifications.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "AdditionalChar":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the inspection plan includes the characteristic.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

SampleResult

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

Parameters:

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

The Sample Results resource manages the sample results for an item.

Back to Top

Examples

This example describes how to create one disposition for one sample in one inspection event.

Example cURL Command

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

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

For example, the following command creates one disposition for sample 300100111678897 in inspection event 300100111678896:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897/child/SampleDisposition"

Example Request Body

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

{
          "Quantity" : 1,
          "Status" : "COMPLETE"
}

Example Response Body

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

{
  "Disposition" : "ACCEPT",
  "IpEventDispositionId" : 300100111679127,
  "IpEventId" : 300100111678896,
  "ObjectVersionNumber" : 2,
  "Quantity" : 1,
  "SampleEventDispositionId" : 300100118590132,
  "SampleId" : 300100111678897,
  "Status" : "COMPLETE",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897/child/SampleDisposition/300100118590132",
    "name" : "SampleDisposition",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897/child/SampleDisposition/300100118590132",
    "name" : "SampleDisposition",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897",
    "name" : "Sample",
    "kind" : "item"
  }, {
    "rel" : "child",
    "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897/child/SampleDisposition/300100118590132/child/SampleResult",
    "name" : "SampleResult",
    "kind" : "collection"
  } ]
}

Back to Top