Get all results
get
/fscmRestApi/resources/11.13.18.05/inspectionEvents/{IpEventId}/child/samplesAndResults
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 the sample result that matches the primary key criteria specified.
Finder Variables:- SampleId :Value that uniquely identifies the sample.
- SampleResultId :Value that uniquely identifies the sample result.
- findSamplesAndResults :Finds the sample results that match the criteria specified.
Finder Variables:- CharacteristicId :Value that uniquely identifies the characteristic.
- CharacteristicName :Name that identifies the characteristic that this event is inspecting in the sample.
- Optional :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.
- SampleId :Value that uniquely identifies the sample.
- SampleNumber :Number that identifies the sample.
- SampleResultId :Value that uniquely identifies the sample result.
- SerialNumber :Number that identifies the serial being inspected.
- PrimaryKey :Finds the sample result that matches the primary key criteria specified.
-
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:- CharacteristicId; integer; Value that uniquely identifies the characteristic.
- CharacteristicName; string; Name that identifies the characteristic that this event is inspecting in the sample.
- InSpecification; string; Value that indicates whether the result meets the specifications.
- IpEventId; integer; Value that uniquely identifies the inspection event.
- Optional; string; 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; Value that uniquely identifies the result evaluation.
- SampleEventDispositionId; integer; Value that uniquely identifies the event sample disposition.
- SampleId; integer; Value that uniquely identifies the sample.
- SampleNumber; string; Number that identifies the sample.
- SampleResultId; integer; Value that uniquely identifies the sample result.
- SerialNumber; string; Number that identifies the serial being inspected.
-
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:
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-samplesAndResults
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-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
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.