Get all criteria
get
/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/criteria
Request
Path Parameters
-
InspectionPlanId(required): integer(int64)
Value that uniquely identifies the inspection plan.
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 inspection criteria according to the inspection plan.
Finder Variables:- CriteriaId; integer; Value that uniquely identifies inspection criteria.
- PrimaryKey: Finds inspection criteria according to the inspection plan.
-
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:- CreatedBy; string; User who created the inspection criteria record.
- CreationDate; string; Date when the user created the inspection criteria.
- CriteriaId; integer; Value that uniquely identifies the inspection plan criteria.
- DispatchStatus; string; Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.
- DocumentType; string; Type of document for the inspection event where InspectionPlanType is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES.
- EnabledFlag; boolean; Contains one of the following values: Yes or No. If Yes, then inspection criteria is enabled. If No, then inspection criteria is not enabled. The default value is Yes.
- InspectionPlanId; integer; Value that uniquely identifies the inspection plan.
- InspectionPlanType; string; Type of inspection plan. Valid values include Receiving, Inventory, Work in process, and Resource. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES.
- LastUpdateDate; string; Date and time when the user most recently updated the inspection criteria.
- LastUpdatedBy; string; User who most recently updated the inspection criteria.
- Locator; string; Value that identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
- LocatorId; integer; Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
- OperationCode; string; Abbreviation that identifies the operation for this item.
- OperationSequenceNumber; integer; Sequence number of the work order operation that occurs during manufacturing inspection.
- ProcurementBUCode; string; Abbreviation that identifies the procurement business unit.
- ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
- SourceOrganization; string; Value that identifies the source organization. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
- SourceOrganizationId; integer; Value that uniquely identifies the organization that requested the item. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
- SubinventoryCode; string; Abbreviation that identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
- SubinventoryId; integer; Value that uniquely identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
- Supplier; string; Name of the supplier. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
- SupplierId; integer; Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
- SupplierSite; string; Value that identifies the supplier site. This attribute is required where InspectionPlanType is Receiving, DocumentType is Purchase order for the specified supplier. This is optional.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order for the specified supplier. This is optional.
- WorkDefinitionNameId; integer; Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
- WorkOrderSubTypeCode; string; Abbreviation that identifies the work order sub type code. This attribute is applicable where inspection plan type is Asset. This is optional.
- WorkOrderSubTypeMeaning; string; Value that identifies the work order sub type. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. This is optional.
- WorkOrderTypeCode; string; Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.
- WorkOrderTypeMeaning; string; Value that identifies the type of work order. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. This is optional.
-
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 : inspectionPlans-criteria
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 : inspectionPlans-criteria-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the inspection criteria record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the inspection criteria. -
CriteriaId: integer
(int64)
Value that uniquely identifies the inspection plan criteria.
-
DispatchStatus: string
Maximum Length:
80
Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject. -
DocumentType: string
Maximum Length:
20
Type of document for the inspection event where InspectionPlanType is Receiving. Valid values include Purchase order, Transfer order, In-transit shipment, and Return material authorization. A list of accepted values is defined in the lookup type ORA_QA_IP_DOC_TYPES. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:true
Contains one of the following values: Yes or No. If Yes, then inspection criteria is enabled. If No, then inspection criteria is not enabled. The default value is Yes. -
InspectionPlanId: integer
(int64)
Value that uniquely identifies the inspection plan.
-
InspectionPlanType: string
Maximum Length:
30
Type of inspection plan. Valid values include Receiving, Inventory, Work in process, and Resource. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the inspection criteria. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the inspection criteria. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Value that identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
-
LocatorId: integer
(int64)
Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
-
OperationCode: string
Maximum Length:
30
Abbreviation that identifies the operation for this item. -
OperationSequenceNumber: integer
Sequence number of the work order operation that occurs during manufacturing inspection.
-
ProcurementBUCode: string
Abbreviation that identifies the procurement business unit.
-
ProcurementBUId: integer
Value that uniquely identifies the procurement business unit.
-
SourceOrganization: string
Value that identifies the source organization. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
-
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the organization that requested the item. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
-
SubinventoryCode: string
Title:
Subinventory
Maximum Length:10
Abbreviation that identifies the subinventory. This attribute is required where InspectionPlanType is Inventory. -
SubinventoryId: integer
Value that uniquely identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
-
Supplier: string
Maximum Length:
255
Name of the supplier. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
-
SupplierSite: string
Value that identifies the supplier site. This attribute is required where InspectionPlanType is Receiving, DocumentType is Purchase order for the specified supplier. This is optional.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order for the specified supplier. This is optional.
-
WorkDefinitionName: string
Maximum Length:
255
Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional. -
WorkDefinitionNameId: integer
(int64)
Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
-
WorkOrderSubTypeCode: string
Maximum Length:
30
Abbreviation that identifies the work order sub type code. This attribute is applicable where inspection plan type is Asset. This is optional. -
WorkOrderSubTypeMeaning: string
Maximum Length:
255
Value that identifies the work order sub type. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. This is optional. -
WorkOrderTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional. -
WorkOrderTypeMeaning: string
Maximum Length:
255
Value that identifies the type of work order. This attribute is applicable where inspection plan type is Asset. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. This is optional.
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.
Examples
This example describes how to get all criteria.
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/inspectionPlans/InspectionPlanId/child/criteria"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [{ "IpCriteriaId": 300100152744381, "ObjectVersionNumber": 1, "InspectionPlanId": 300100152744368, "InspectionPlanType": "RECEIVING", "OperationSequenceNumber": null, "OperationCode": null, "DispatchStatus": null, "DocumentType": "INVENTORY", "SupplierId": null, "SupplierSiteId": null, "SourceOrganizationId": 207, "SubinventoryCode": null, "LocatorId": null, "EnabledFlag": true, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2018-07-02T08:02:59+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "LastUpdateDate": "2018-07-02T08:03:00.318+00:00", "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB", "SubinventoryId": null, "Supplier": null, "ProcurementBUId": null, "ProcurementBUCode": null, "SupplierSite": null, "Locator": null, "SourceOrganization": "Seven Corporation$$?$$DEPARTMENT1", "links": [{ "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381", "name": "criteria", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381", "name": "criteria", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368", "name": "inspectionPlans", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/SourceOrgaizationLOV", "name": "SourceOrgaizationLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/SupplierLOV", "name": "SupplierLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/SubInventoryLOV", "name": "SubInventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/DispatchStatusLOV", "name": "DispatchStatusLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/LocatorLOV", "name": "LocatorLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/OperationCodeLOV", "name": "OperationCodeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/SupplierSiteLOV", "name": "SupplierSiteLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744381/lov/DocumentTypeLOV", "name": "DocumentTypeLOV", "kind": "collection" }] }, { "IpCriteriaId": 300100152744370, "ObjectVersionNumber": 1, "InspectionPlanId": 300100152744368, "InspectionPlanType": "RECEIVING", "OperationSequenceNumber": null, "OperationCode": null, "DispatchStatus": null, "DocumentType": "RMA", "SupplierId": null, "SupplierSiteId": null, "SourceOrganizationId": null, "SubinventoryCode": null, "LocatorId": null, "EnabledFlag": true, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2018-07-02T07:40:18.428+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "LastUpdateDate": "2018-07-02T07:40:18.763+00:00", "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB", "SubinventoryId": null, "Supplier": null, "ProcurementBUId": null, "ProcurementBUCode": null, "SupplierSite": null, "Locator": null, "SourceOrganization": null, "links": [{ "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370", "name": "criteria", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370", "name": "criteria", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368", "name": "inspectionPlans", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/SourceOrgaizationLOV", "name": "SourceOrgaizationLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/SupplierLOV", "name": "SupplierLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/SubInventoryLOV", "name": "SubInventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/DispatchStatusLOV", "name": "DispatchStatusLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/LocatorLOV", "name": "LocatorLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/OperationCodeLOV", "name": "OperationCodeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/SupplierSiteLOV", "name": "SupplierSiteLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria/300100152744370/lov/DocumentTypeLOV", "name": "DocumentTypeLOV", "kind": "collection" }] }], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [{ "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria", "name": "criteria", "kind": "collection" }] }