Get all samples
get
/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/Sample
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds samples.
Finder Variables:- SampleId; integer; Value that uniquely identifies the sample.
- SampleRowFinder: Finds samples according to the secondary keys.
Finder Variables:- IpEventId; integer; Value that uniquely identifies the inspection event.
- SampleNumber; string; Number that identifies the sample.
- SerialNumber; string; Number that identifies the serial.
- PrimaryKey: Finds samples.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- INVSerialNumber; string; List of values for the inventory serial number that is work in process.
- IpEventId; integer; Value that uniquely identifies the event that inspects this sample.
- ObjectVersionNumber; integer; 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; Original disposition for the sample to inspect.
- Quantity; number; Sample quantity.
- SampleId; integer; Value that uniquely identifies the sample to inspect.
- SampleNumber; string; If the inspection inspects a nonserial item, then SampleNumber contains the sample number.
- SerialNumber; string; If the inspection inspects a nonserial item, then SerialNumber contains the serial number.
- UOMCode; string; 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; Value that uniquely identifies the transaction for the work order operation.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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(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.
Root Schema : inspectionEvents-Sample
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
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 : 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-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. -
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
Examples
This example describes how to get all samples for 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/child/Sample"
For example, the following command gets all samples for inspection event 300100111678896:
curl -u username:password "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "IpEventId" : 300100111678896, "ObjectVersionNumber" : 1, "OriginalDisposition" : null, "Quantity" : 1, "SampleId" : 300100111678897, "SampleNumber" : "00001", "SerialNumber" : null, "UOMCode" : "Ea", "WoOperationTransactionId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897", "name" : "Sample", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897", "name" : "Sample", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896", "name" : "inspectionEvents", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample/300100111678897/child/SampleDisposition", "name" : "SampleDisposition", "kind" : "collection" } ] } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/inspectionEvents/300100111678896/child/Sample", "name" : "Sample", "kind" : "collection" } ] }