Create one criterion
post
/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/criteria
Request
Path Parameters
-
InspectionPlanId(required): integer(int64)
Value that uniquely identifies the inspection plan.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
Response
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-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 create one criteria.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inspectionPlans/InspectionPlanId/child/criteria"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "DocumentType": "INVENTORY", "SourceOrganization": "M1" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "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": "M1", "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" }] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the
request payload in the cURL command with the contents of the Example Request Body to create one receiving inspection plan. The request payload specifies attribute values that the command will use in the record that it creates.
{ "WorkOrderTypeCode" : "CORRECTIVE", "WorkOrderSubTypeCode" : "ORA_CONDITION_BASED", "WorkDefinitionName" : "Service - Generator - Diesel", "OperationSequenceNumber" : 10, "OperationCode" : "ELEC" }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "CriteriaId": 300100580474315, "InspectionPlanId": 300100580469102, "InspectionPlanType": "ASSET", "OperationSequenceNumber": 10, "OperationCode": "ELEC", "DispatchStatus": "READY", "DocumentType": null, "SupplierId": null, "SupplierSiteId": null, "SourceOrganizationId": null, "SubinventoryCode": null, "LocatorId": null, "EnabledFlag": true, "CreatedBy": "QUALITY_ENGINEER", "CreationDate": "2023-01-30T07:24:53+00:00", "LastUpdatedBy": "QUALITY_ENGINEER", "LastUpdateDate": "2023-01-30T07:24:53.685+00:00", "SubinventoryId": null, "Supplier": null, "ProcurementBUId": null, "ProcurementBUCode": null, "SupplierSite": null, "Locator": null, "SourceOrganization": null, "WorkOrderTypeCode": "CORRECTIVE", "WorkOrderSubTypeCode": "ORA_CONDITION_BASED", "WorkDefinitionNameId": 300100114215713, "WorkDefinitionName": "Service - Generator - Diesel", "WorkOrderTypeMeaning": "Corrective", "WorkOrderSubTypeMeaning": "Condition based", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315", "name": "criteria", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315", "name": "criteria", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102", "name": "inspectionPlans", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/SupplierSiteLOV", "name": "SupplierSiteLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/LocatorLOV", "name": "LocatorLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/DispatchStatusLOV", "name": "DispatchStatusLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/WorkDefinitionMaintenanceNamePVO1", "name": "WorkDefinitionMaintenanceNamePVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/WorkOrderTypeLOV", "name": "WorkOrderTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/DocumentTypeLOV", "name": "DocumentTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/OperationCodeLOV", "name": "OperationCodeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/SubInventoryLOV", "name": "SubInventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/SupplierLOV", "name": "SupplierLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/SourceOrgaizationLOV", "name": "SourceOrgaizationLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100580469102/child/criteria/300100580474315/lov/WorkOrderSubTypeVA", "name": "WorkOrderSubTypeVA", "kind": "collection" } ] }