Get all inspection actions for an inspection event.
get
/fscmRestApi/resources/11.13.18.05/inspectionActions
Request
Query Parameters
-
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 actions that match the primary key criteria specified.
Finder Variables- IpEventId; integer; Finds the inspection event that matches the primary key criteria specified.
- PrimaryKey Finds the actions that match 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:- ActionStatus; string; Value that indicates the action creation status. A Success status means that the operation performed successfully.
- InspectionPlanId; integer; Value that indicates the inspection plan ID that's used for the action creation process.
- InspectionPlanName; string; Value that identifies the inspection plan name that's used for the action creation process.
- IpEventId; integer; Value that uniquely identifies the inspection event.
- MessageText; string; Error message that's returned if the action creation fails.
-
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 : inspectionActions
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 : inspectionActions-item-response
Type:
Show Source
object
-
ActionStatus: string
Maximum Length:
255
Value that indicates the action creation status. A Success status means that the operation performed successfully. -
inspectionEventActions: array
Inspection Event Actions
Title:
Inspection Event Actions
The Inspection Actions resource is used to view inspection actions for the inspection event. -
InspectionPlanId: integer
Value that indicates the inspection plan ID that's used for the action creation process.
-
InspectionPlanName: string
Maximum Length:
255
Value that identifies the inspection plan name that's used for the action creation process. -
IpEventId: integer
Value that uniquely identifies the inspection event.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageText: string
Maximum Length:
255
Error message that's returned if the action creation fails.
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 : inspectionActions-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 : 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.