Get one event
get
/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}
Request
Path Parameters
-
IpEventId(required): integer
Value that uniquely identifies the inspection event.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : inspectionEvents-item-response
Type:
Show Source
object
-
AcceptanceNumber: number
Number that indicates the acceptance associated with the sampling plan.
-
AcceptanceQualityLimit: number
Acceptance Quality Limit along with the Sample Size Code Letter is used to determine the sampling size. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_AQL.
-
AssetId: integer
(int64)
Value that uniquely identifies the asset number to inspect if inspection type is Asset.
-
AssetInspectionPlanName: string
Maximum Length:
255
Name of the inspection plan for asset type inspection. -
AssetNumber: string
Maximum Length:
80
Alphanumeric value that identifies the asset number to inspect if inspection type is Asset. -
AssetSerialNumber: string
Maximum Length:
255
Number that identifies the serial number associated with asset number for an asset inspection. -
AssetWorkOrderId: integer
Value that uniquely identifies the maintenance work order for an asset inspection.
-
AssetWorkOrderNumber: string
Maximum Length:
255
Alphanumeric value that identifies the maintenance work order of an asset inspection. -
Attachments: array
Result Attachments
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results. -
CategoryId: integer
(int64)
Value that uniquely identifies the category of the item to inspect.
-
CategorySetId: integer
(int64)
Value that uniquely identifies the catalog of the item to inspect.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the inspection event. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the inspection event was created. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer returning the item to inspect.
-
DispatchStatus: string
Maximum Length:
30
Dispatch status of the work order operation for the inspected item. -
DispositionDate: string
(date-time)
Disposition date of the work order operation for the inspected item.
-
DispositionMeaning: string
Read Only:
true
Maximum Length:80
Indicates the disposition of the inspection. Valid values are: Accepted, Completed, In Progress, Pending, and Rejected. -
DocumentLineNumber: number
Document line number of the receiving inspection event.
-
DocumentNumber: string
Maximum Length:
240
Document number of the receiving inspection event. -
DocumentScheduleNumber: string
Maximum Length:
50
Document schedule number of the receiving inspection event. -
DocumentType: string
Maximum Length:
50
Document type of the receiving inspection event. -
Draft: string
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the transactions are not finished. If N, then transactions are finished. This attribute does not have a default value.. -
eventCharacteristics: array
Inspection Event Characteristics
Title:
Inspection Event Characteristics
Distinct characteristics for the inspection event. -
EventDisposition: array
Event Dispositions
Title:
Event Dispositions
The Event Dispositions resource manages event dispositions. -
EventType: string
Maximum Length:
20
Type of event. Valid values are WIP, RCV, INV, RES, or AST. -
EventTypeLOV: string
List of values for the event type.
-
EventTypeMeaning: string
Read Only:
true
Maximum Length:80
Indicates the type of inspection. Valid values are: Asset, Inventory, Receiving, Resource, and Work in Process. -
ExecuteActionRulesFlag: boolean
Maximum Length:
1
Indicates whether action rules defined in plan are executed or not. Options are Y, N and Null (treated as No). Only applicable when using the Inspection Events REST resource. -
FromOrganizationId: integer
Value that uniquely identifies the source organization.
-
Inline: string
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the application collects results as part of a receipt or work order, and the application requires the transaction identifiers. If N, then the application collects results independent of the receipt or work order, and the application does not require the transaction identifiers. This attribute does not have a default value. -
InspectAllSamplesFlag: boolean
Maximum Length:
255
Contains one of the following values: true or false. If true, then all samples are created for inspection based on the document line quantity. If false, then the samples are created based on the sampling rate. This attribute does not have a default value. -
InspectedBy: string
Maximum Length:
64
Person who performs the inspection. -
InspectionDate: string
(date-time)
Date and time when the inspection event occurred.
-
inspectionEventActions: array
Inspection Event Actions
Title:
Inspection Event Actions
The Inspection Actions resource is used to view inspection actions for the inspection event. -
InspectionLevelId: integer
(int64)
Value that uniquely identifies the inspection level.
-
InspectionLevelName: string
Name of the inspection level.
-
InspectionName: string
Name of the inspection event. This attribute is derived based on the EventSource.
-
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
InspectionPlanType: string
Name of the type of inspection plan.
-
InspectionPlanVersion: string
Version of the inspection plan.
-
InspectionPlanVersionDescription: string
Description of the version of the inspection plan.
-
InspectionStatus: string
Maximum Length:
20
Inspection status. Valid values include PENDING or COMPLETE. -
InterfaceTransactionId: integer
(int64)
Value that uniquely identifies the interface transaction when inspecting a receipt. This attribute references the RCV_TRANSACTIONS_INTERFACE table.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item to inspect.
-
INVInspectionPlanName: string
Name of the inventory inspection plan.
-
IpCriteriaId: integer
(int64)
Value that uniquely identifies the inspection criteria record.
-
IpEventId: integer
(int64)
Value that uniquely identifies the inspection event.
-
isSamplingEnabled: string
Value that indicates whether the application uses sampling.
-
isSkiplotEnabled: string
Value that indicates whether the application uses skip lots.
-
ItemDescription: string
Description of the item.
-
ItemNumber: string
Number that identifies the item.
-
ItemRevision: string
Revision of the item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user last updated the inspection event. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the inspection event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Value that uniquely identifies the locator. -
LocatorId: integer
(int64)
Value that uniquely identifies the subinventory locator of the item to inspect in this event.
-
LotNumber: string
Maximum Length:
80
Lot number inspected in this event. -
NonConformanceCount: number
Total number of non-conformities in an inspection event. This attribute is derived as one hundred times the number of nonconforming units divided by the total number of units of product.
-
NumofLots: integer
Number of lots.
-
NumofLotsInspect: integer
Number of lots to inspect.
-
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. -
OperationSequenceNumber: integer
Sequence number of the work order operation to use during manufacturing inspection.
-
OrganizationCode: string
Abbreviation that identifies the list of values for the organization.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organization. -
OriginalDisposition: string
Maximum Length:
20
Original disposition of the items to inspect. -
PreAssignedLotNumber: string
Value that identifies the preassigned lot inspected in the event. This attribute should be used instead of LotNumber when a lot has been preassigned to a work order operation.
-
QuantityAccepted: number
Total quantity accepted in this event.
-
QuantityInspected: number
Total quantity inspected in this event.
-
QuantityRejected: number
Total quantity rejected in this event.
-
QuantityRequested: number
Requested inspection quantity received from the plant or from receiving.
-
RCVInspectionPlanName: string
Name of the receiving inspection plan.
-
ReceiptNumber: string
Maximum Length:
30
Receipt number that this inspection event inspects. -
RejectionNumber: number
Number that indicates the rejection associated with the sampling plan.
-
ResourceCode: string
Abbreviation that identifies the resource.
-
ResourceId: integer
(int64)
Identifies the resource to inspect.
-
ResourceInspectionPlanName: string
Name of the resource inspection plan.
-
RevisionId: integer
(int64)
If revisions control the item, then this value uniquely identifies the inspected item.
-
Sample: array
Samples
Title:
Samples
The Samples resource manages sample items. -
samplesAndResults: array
Sample and Results
Title:
Sample and Results
A flattened structure that's used to view or modify samples and results. -
SampleSizeCode: string
Maximum Length:
3
Abbreviation that identifies the sample size associated with the inspection level. -
SamplingLevelCode: string
Maximum Length:
5
Determines the relationship between the lot or batch size and the sample size. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_INSP_LEVEL. -
SamplingPlanType: string
Maximum Length:
30
Code of the sampling plan type. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_PLAN_TYPE. -
SamplingQuantity: number
Quantity from the sampling plan to inspect.
-
SamplingRate: number
Rate of the sampling.
-
SamplingStandardCode: string
Maximum Length:
30
Sampling standard code associated with the inspection level. A list of accepted values is defined in the lookup type ORA_QA_SAMPLING_STD. -
SerialResultsEntryFlag: boolean
Contains one of the following values: true or false. If true, then serials are created for inspection. If false, then samples are created for inspection. This attribute does not have a default value.
-
ShipmentHeaderId: integer
(int64)
Value that uniquely identifies the shipment header of the item to inspect.
-
ShipmentLineId: integer
(int64)
Value that uniquely identifies the shipment line of the item to inspect.
-
SourceDocumentCode: string
Abbreviation that identifies the source document.
-
SourceLineQuantity: number
Total quantity on the source line. It measures the receiving transaction quantity or the completion quantity of a manufacturing operation.
-
SourceOrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the source organization. This attribute is required when EventType is Receiving and DocumentType is In-transit shipment or Transfer order. -
SourceOrgId: integer
(int64)
If the receiving transaction type is a transfer, then SourceOrgId identifies the source organization.
-
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory that stores the inspected item. -
SubinventoryId: integer
Value that uniquely identifies the subinventory.
-
Supplier: string
Name of the supplier. This attribute is required when EventType is Receiving and DocumentType is Purchase order.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier of the item to inspect.
-
SupplierLotNumber: string
Maximum Length:
80
Number that identifies the shipment lot. -
SupplierSite: string
Name of the supplier site. This attribute is required when EventType is Receiving, DocumentType is Purchase order for the specified supplier.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TotalSampleQuantity: number
Total amount of material required for testing in the inspection quantity unit of measure.
-
TransactionType: string
Maximum Length:
25
Receiving transaction type. -
UOMCode: string
Maximum Length:
3
Unit of measurement for the quantity of items to inspect in this event. -
VendorId: integer
Value that uniquely identifies the vendor.
-
VendorSiteId: integer
Value that uniquely identifies the vendor site.
-
WIPInspectionPlanName: string
Name of the inspection plan for work in process.
-
WoOperationCode: string
Abbreviation that identifies the work order operation.
-
WoOperationId: integer
(int64)
Value that uniquely identifies the work order operation in a manufacturing inspection.
-
WoOperationName: string
Name of the work order operation associated with the inspection event.
-
WorkAreaId: integer
(int64)
Value that uniquely identifies the work area for a resource inspection.
-
WorkCenterCode: string
Abbreviation that identifies the work center.
-
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center for a resource inspection.
-
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order for a manufacturing inspection.
-
WorkOrderNumber: string
Number that identifies the list of values for the work order.
Nested Schema : Result Attachments
Type:
array
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results.
Show Source
Nested Schema : Inspection Event Characteristics
Type:
array
Title:
Inspection Event Characteristics
Distinct characteristics for the inspection event.
Show Source
Nested Schema : Event Dispositions
Type:
array
Title:
Event Dispositions
The Event Dispositions resource manages event dispositions.
Show Source
Nested Schema : Inspection Event Actions
Type:
array
Title:
Inspection Event Actions
The Inspection Actions resource is used to view inspection actions for the inspection event.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Samples
Type:
array
Title:
Samples
The Samples resource manages sample items.
Show Source
Nested Schema : Sample and Results
Type:
array
Title:
Sample and Results
A flattened structure that's used to view or modify samples and results.
Show Source
Nested Schema : inspectionEvents-Attachments-item-response
Type:
Show Source
object
-
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
-
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. -
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
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inspectionEvents-eventCharacteristics-item-response
Type:
Show Source
object
-
CharacteristicId: integer
Read Only:
true
Value that uniquely identifies the characteristic. -
CharacteristicType: string
Read Only:
true
Maximum Length:30
Code that identifies the characteristic type. The accepted values are ITEM and NON_ITEM. -
DataType: string
Read Only:
true
Maximum Length:30
Data type of the characteristic. -
Description: string
Read Only:
true
Maximum Length:240
Translatable description of characteristic. -
IpEventId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inspection event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumValue: string
Read Only:
true
Maximum Length:80
Upper limit of the acceptable numeric range for an inspection characteristic. -
MaximumValueDate: string
(date-time)
Read Only:
true
Upper limit of the acceptable date range for an inspection characteristic. -
MinimumValue: string
Read Only:
true
Maximum Length:80
Lower limit of the acceptable numeric range for an inspection characteristic. -
MinimumValueDate: string
(date-time)
Read Only:
true
Lower limit of the acceptable date range for an inspection characteristic. -
Name: string
Read Only:
true
Maximum Length:80
Name that identifies the characteristic that this event is inspecting in the sample. -
TargetValue: string
Read Only:
true
Maximum Length:80
Target value of the inspection characteristic. -
TargetValueDate: string
(date-time)
Read Only:
true
Optimal date value for the inspection characteristic.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionEvents-EventDisposition-item-response
Type:
Show Source
object
-
Disposition: string
Maximum Length:
30
Disposition of the samples in the inspection event. Valid values include ACCEPT, REJECT, COMPLETE, or PENDING. -
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan that this event uses for the inspection.
-
IpEventDispositionId: integer
(int64)
Value that uniquely identifies the primary key of the event disposition.
-
IpEventId: integer
(int64)
Value that uniquely identifies the inspection event to use when recording the sample disposition.
-
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
Quantity of samples inspected.
-
RcvTransactionId: integer
(int64)
Value that uniquely identifies the transaction when the source is RCV.
-
WoOperationTransactionId: integer
(int64)
Value that uniquely identifies the transaction when the source is MFG.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionEvents-inspectionEventActions-item-response
Type:
Show Source
object
-
ActionTaken: string
Read Only:
true
Maximum Length:32
Value that indicates the action taken. -
AsActionTakenDate: string
(date-time)
Read Only:
true
Date and time that action was executed. -
IpEventId: integer
Read Only:
true
Value that uniquely identifies the inspection event. -
IssueDescription: string
Read Only:
true
Maximum Length:3999
Description of quality issue created by the action. -
IssueId: number
Read Only:
true
Value that uniquely identifies the quality issue created by the action. -
IssueName: string
Read Only:
true
Maximum Length:400
Name of the quality issue created by the action. -
IssueNumber: string
Read Only:
true
Maximum Length:100
Quality issue number generated by the action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialStatusLevel: string
Read Only:
true
Maximum Length:32
Value that indicates the level of the material status change. -
MessageName: string
Read Only:
true
Maximum Length:100
Message code returned by the system based on the action. -
MessageText: string
Read Only:
true
Maximum Length:2400
Message details for the action. -
Notifiers: string
Read Only:
true
Maximum Length:4000
List of notification recipients. -
SampleId: number
Read Only:
true
Value that uniquely identifies the sample to inspect. -
SampleNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the sample being inspected for a nonserial item. -
SampleResultId: number
Read Only:
true
Value that uniquely identifies the result of the sample inspection. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the serial being inspected. -
StatusCode: string
Read Only:
true
Maximum Length:80
New material status based on this action. -
StatusId: integer
(int64)
Read Only:
true
Value that uniquely identifies the new material status based on the action. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order created by the action. -
WorkOrderNumber: string
Read Only:
true
Maximum Length:120
Work order number created by the action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionEvents-Sample-item-response
Type:
Show Source
object
-
INVSerialNumber: string
List of values for the inventory serial number that is 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
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. -
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 manages sample item dispositions. -
SampleId: integer
(int64)
Value that uniquely identifies the sample to inspect.
-
SampleNumber: string
Maximum Length:
80
If the inspection inspects a nonserial item, then SampleNumber contains the sample number. -
SerialNumber: string
Maximum Length:
80
If the inspection inspects a nonserial item, then SerialNumber contains the serial number. -
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 is work in process.
-
WoOperationTransactionId: integer
(int64)
Value that uniquely identifies the transaction for the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sample Dispositions
Type:
array
Title:
Sample Dispositions
The Sample Dispositions resource manages sample item dispositions.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sample Results
Type:
array
Title:
Sample Results
The Sample Results resource manages the sample results for an item.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-item-response
Type:
Show Source
object
-
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.
Nested Schema : Result Attachments
Type:
array
Title:
Result Attachments
The Result Attachments resource manages the attachments for the sample results.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Result Evaluations
Type:
array
Title:
Result Evaluations
The Result Evaluations resource manages the evaluation results.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-Attachments-item-response
Type:
Show Source
object
-
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
-
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. -
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
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionEvents-Sample-SampleDisposition-SampleResult-ResultEvaluation-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inspectionEvents-samplesAndResults-item-response
Type:
Show Source
object
-
AdditionalResult: string
Read Only:
true
Maximum Length:1
Value that indicates whether the inspection plan includes the characteristic. -
AttachmentAdded: string
Read Only:
true
Maximum Length:255
Indicates if attachments are added to the sample result. -
CharacteristicDescription: string
Read Only:
true
Maximum Length:240
Translatable description of characteristic. -
CharacteristicId: integer
(int64)
Read Only:
true
Value that uniquely identifies the characteristic. -
CharacteristicName: string
Read Only:
true
Maximum Length:80
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
Read Only:
true
Maximum Length:30
Data type of the characteristic. -
Evaluation: string
Read Only:
true
Maximum Length:1
Value that indicates whether the disposition evaluates the result. -
InSpecification: string
Read Only:
true
Maximum Length:1
Value that indicates whether the result meets the specifications. -
InspectionDate: string
(date-time)
Date and time that this event collected this result.
-
IpEventId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inspection event. -
IpSpecificationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inspection plan specification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumValue: string
Read Only:
true
Maximum Length:80
Upper limit of the acceptable numeric range for an inspection characteristic. -
MaximumValueDate: string
(date-time)
Read Only:
true
Upper limit of the acceptable date range for an inspection characteristic. -
MinimumValue: string
Read Only:
true
Maximum Length:80
Lower limit of the acceptable numeric range for an inspection characteristic. -
MinimumValueDate: string
(date-time)
Read Only:
true
Lower limit of the acceptable date range for an inspection characteristic. -
NonValidated: string
Read Only:
true
Maximum Length:255
Indicates if the characteristic is nonvalidated. -
Optional: string
Read Only:
true
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. -
ResultEvaluationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the result evaluation. -
ResultValueCharacter: string
Maximum Length:
80
Inspection result represented as a string. If this resource can represent this result as a string, then it uses ResultValueChar. -
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.
-
SampleDisposition: string
Title:
Sample Dispositions
Read Only:true
Maximum Length:30
Result of the inspection disposition. Values include ACCEPT or REJECT. -
SampleEventDispositionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the event sample disposition. -
SampleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sample. -
SampleNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the sample. -
SampleResultId: integer
(int64)
Read Only:
true
Value that uniquely identifies the sample result. -
SampleStatus: string
Read Only:
true
Maximum Length:20
Sample status. Valid values include PENDING or COMPLETE. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the serial being inspected. -
TargetValue: string
Read Only:
true
Maximum Length:80
Target value of the inspection characteristic. -
TargetValueDate: string
(date-time)
Read Only:
true
Optimal date value for the inspection characteristic. -
UserSequence: integer
(int32)
Read Only:
true
User sequence.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- IpEventId:
$request.path.IpEventId
The Result Attachments resource manages the attachments for the sample results. - IpEventId:
- EventDisposition
-
Parameters:
- IpEventId:
$request.path.IpEventId
The Event Dispositions resource manages event dispositions. - IpEventId:
- Sample
-
Parameters:
- IpEventId:
$request.path.IpEventId
The Samples resource manages sample items. - IpEventId:
- addCharacteristicToSamples
-
Operation: /fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/action/addCharacteristicToSamplesParameters:
- IpEventId:
$request.path.IpEventId
Adds a list of characteristics or a group of characteristics to a list of samples or all samples of an inspection. Returns an error if empty list of characteristics or groups is passed. - IpEventId:
- applyResultValue
-
Parameters:
- IpEventId:
$request.path.IpEventId
Updates the result value to a list of samples of an inspection. Sample lists and characteristics in the sample will be updated with the result value and will be passed as input to the action. Returns an error if empty samples list is passed. - IpEventId:
- eventCharacteristics
-
Operation: /fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/eventCharacteristicsParameters:
- IpEventId:
$request.path.IpEventId
Distinct characteristics for the inspection event. - IpEventId:
- inspectionEventActions
-
Operation: /fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/inspectionEventActionsParameters:
- IpEventId:
$request.path.IpEventId
The Inspection Actions resource is used to view inspection actions for the inspection event. - IpEventId:
- samplesAndResults
-
Parameters:
- IpEventId:
$request.path.IpEventId
A flattened structure that's used to view or modify samples and results. - IpEventId:
- updateSerials
-
Parameters:
- IpEventId:
$request.path.IpEventId
Updates serial numbers when inspection is performed against a serial controlled item. Returns an error if empty serials or invalid serials are passed. - IpEventId:
Examples
This example describes how to get one inspection event.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionEvents/IpEventId"
For example, the following command gets details for inspection plan event 300100075637480:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionEvents/300100075637480"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CategoryId" : null, "CategorySetId" : null, "CustomerId" : null, "DispatchStatus" : null, "DispositionDate" : "2016-02-16", "DocumentLineNumber" : null, "DocumentNumber" : null, "DocumentScheduleNumber" : null, "DocumentType" : null, "Draft" : "N", "EventType" : "WIP", "Inline" : "N", "InspectedBy" : "MFG_QA", "InspectionDate" : "2016-02-03", "InspectionLevelId" : 300100071895689, "InspectionPlanId" : 300100072194465, "InspectionStatus" : "COMPLETE", "InterfaceTransactionId" : null, "InventoryItemId" : null, "IpCriteriaId" : null, "IpEventId" : 300100075637480, "LocatorId" : null, "LotNumber" : null, "ObjectVersionNumber" : 1, "OperationSequenceNumber" : null, "OrganizationId" : 207, "OriginalDisposition" : "COMPLETE", "QuantityAccepted" : 1, "QuantityInspected" : 1, "QuantityRejected" : 0, "QuantityRequested" : 1, "ReceiptNumber" : null, "ResourceId" : 300100071982971, "RevisionId" : null, "SamplingQuantity" : 1, "ShipmentHeaderId" : null, "ShipmentLineId" : null, "SourceLineQuantity" : 0, "SourceOrgId" : null, "SubinventoryCode" : null, "SupplierId" : null, "SupplierLotNumber" : null, "SupplierSiteId" : null, "TransactionType" : null, "UOMCode" : "EA", "WoOperationId" : null, "WorkAreaId" : null, "WorkCenterId" : 300100071982990, "WorkOrderId" : null, "Sample" : [ { "IpEventId" : 300100075637480, "ObjectVersionNumber" : 1, "OriginalDisposition" : null, "Quantity" : 1, "SampleId" : 300100075637482, "SampleNumber" : "00001", "SerialNumber" : null, "UOMCode" : "EA", "WoOperationTransactionId" : null, "SampleDisposition" : [ { "Disposition" : "ACCEPT", "IpEventDispositionId" : 300100075637481, "IpEventId" : 300100075637480, "ObjectVersionNumber" : 2, "Quantity" : 1, "SampleEventDispositionId" : 300100075637483, "SampleId" : 300100075637482, "Status" : "COMPLETE", "SampleResult" : [ { "CharacteristicId" : 300100071895407, "Comments" : null, "Disposition" : "ACCEPT", "Evaluation" : "Y", "InSpecification" : "Y", "InspectionDate" : "2016-02-03T01:24:00-08:00", "IpEventId" : 300100075637480, "ObjectVersionNumber" : 1, "Quantity" : 1, "ResultValueChar" : null, "ResultValueDate" : null, "ResultValueNumber" : 1, "SampleId" : 300100075637482, "SampleResultId" : 300100075637484, "SpecificationMaximum" : "6", "SpecificationMinimum" : "1", "SpecificationTarget" : null, "UOMCode" : "EA", "UserSequence" : 10, "ResultEvaluation" : [ { "AdditionalChar" : "N", "Evaluation" : "Y", "InSpecification" : "Y", "IpEventDispositionId" : 300100075637481, "IpEventId" : 300100075637480, "ObjectVersionNumber" : 2, "ResultEvaluationId" : 300100075637485, "SampleResultId" : 300100075637484, "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483/child/SampleResult/300100075637484/child/ResultEvaluation/300100075637485", "name" : "ResultEvaluation", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483/child/SampleResult/300100075637484/child/ResultEvaluation/300100075637485", "name" : "ResultEvaluation", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483/child/SampleResult/300100075637484", "name" : "SampleResult", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483/child/SampleResult/300100075637484", "name" : "SampleResult", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483/child/SampleResult/300100075637484", "name" : "SampleResult", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483", "name" : "SampleDisposition", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483", "name" : "SampleDisposition", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482/child/SampleDisposition/300100075637483", "name" : "SampleDisposition", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482", "name" : "Sample", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482", "name" : "Sample", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/Sample/300100075637482", "name" : "Sample", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480", "name" : "inspectionEvents", "kind" : "item" } ] } ], "EventDisposition" : [ { "Disposition" : "ACCEPT", "InspectionPlanId" : 300100072194465, "IpEventDispositionId" : 300100075637481, "IpEventId" : 300100075637480, "ObjectVersionNumber" : 2, "Quantity" : 1, "RcvTransactionId" : null, "WoOperationTransactionId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/EventDisposition/300100075637481", "name" : "EventDisposition", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480/child/EventDisposition/300100075637481", "name" : "EventDisposition", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480", "name" : "inspectionEvents", "kind" : "item" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480", "name" : "inspectionEvents", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/costManagementApi/resources/version/inspectionEvents/300100075637480", "name" : "inspectionEvents", "