Jump to

• Request
• Response
• Examples

Update a criteria

patch

/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}/child/criteria/{CriteriaId}

Request

Path Parameters

• CriteriaId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• InspectionPlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 inspection plan type 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 isn't 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 are Receiving, Inventory, Work in Process, Asset, 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 inspection plan type 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 inspection plan type 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 inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.
• SourceOrganizationName: string
  Maximum Length: 255

  Value that identifies the source organization. This attribute is required where inspection plan type 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 inspection plan type is Inventory.
• SubinventoryId: integer
  Value that uniquely identifies the subinventory. This attribute is required where inspection plan type is Inventory.
• Supplier: string
  Maximum Length: 255

  Name of the supplier. This attribute is required where inspection plan type is Receiving and document type is Purchase order.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where inspection plan type is Receiving and document type is Purchase order.
• SupplierSite: string
  Value that identifies the supplier site. This attribute is required where inspection plan type is Receiving, document type 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 inspection plan type is Receiving and document type 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 subtype 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 subtype. 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.

{
    "type":"object",
    "properties":{
        "DispatchStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DocumentType":{
            "maxLength":20,
            "type":"string",
            "description":"Type of document for the inspection event where inspection plan type 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then inspection criteria is enabled. If No, then inspection criteria isn't enabled. The default value is Yes.",
            "nullable":false,
            "default":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InspectionPlanType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of inspection plan. Valid values are Receiving, Inventory, Work in Process, Asset, and Resource. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES.",
            "nullable":false
        },
        "Locator":{
            "type":"string",
            "description":"Value that identifies the locator within the subinventory. This attribute is required where inspection plan type is Inventory. This is optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OperationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the operation for this item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OperationSequenceNumber":{
            "type":"integer",
            "description":"Sequence number of the work order operation that occurs during manufacturing inspection.",
            "nullable":true
        },
        "ProcurementBUCode":{
            "type":"string",
            "description":"Abbreviation that identifies the procurement business unit.",
            "nullable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true
        },
        "SourceOrganization":{
            "type":"string",
            "description":"Value that identifies the source organization. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that requested the item. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the source organization. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "nullable":true,
            "x-queryable":false
        },
        "SubinventoryCode":{
            "title":"Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory. This attribute is required where inspection plan type is Inventory.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory. This attribute is required where inspection plan type is Inventory.",
            "nullable":true
        },
        "Supplier":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier. This attribute is required where inspection plan type is Receiving and document type is Purchase order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where inspection plan type is Receiving and document type is Purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierSite":{
            "type":"string",
            "description":"Value that identifies the supplier site. This attribute is required where inspection plan type is Receiving, document type is Purchase order for the specified supplier. This is optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site. This attribute is required where inspection plan type is Receiving and document type is Purchase order for the specified supplier. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkDefinitionName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkDefinitionNameId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkOrderSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work order subtype code. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true
        },
        "WorkOrderSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the work order subtype. 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkOrderTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.",
            "nullable":true
        },
        "WorkOrderTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : inspectionPlans-criteria-item-response

Type: object

Show Source

• 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.
• DispatchStatusMeaning: string
  Read Only: true

  Maximum Length: 60

  Value that identifies the dispatch status of the work order operation.Valid Accepted values include Ready and Reject.
• DocumentType: string
  Maximum Length: 20

  Type of document for the inspection event where inspection plan type 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.
• DocumentTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the type of document for the inspection event where the inspection plan type 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 isn't 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 are Receiving, Inventory, Work in Process, Asset, 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 inspection plan type 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.
• OperationCodeMeaning: string
  Read Only: true

  Maximum Length: 480

  Value that identifies the operation that the item is associated to.
• 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 inspection plan type 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 inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.
• SourceOrganizationName: string
  Maximum Length: 255

  Value that identifies the source organization. This attribute is required where inspection plan type 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 inspection plan type is Inventory.
• SubinventoryId: integer
  Value that uniquely identifies the subinventory. This attribute is required where inspection plan type is Inventory.
• Supplier: string
  Maximum Length: 255

  Name of the supplier. This attribute is required where inspection plan type is Receiving and document type is Purchase order.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where inspection plan type is Receiving and document type is Purchase order.
• SupplierSite: string
  Value that identifies the supplier site. This attribute is required where inspection plan type is Receiving, document type 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 inspection plan type is Receiving and document type 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 subtype 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 subtype. 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the inspection criteria record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the inspection criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DispatchStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DispatchStatusMeaning":{
            "maxLength":60,
            "type":"string",
            "description":"Value that identifies the dispatch status of the work order operation.Valid Accepted values include Ready and Reject.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentType":{
            "maxLength":20,
            "type":"string",
            "description":"Type of document for the inspection event where inspection plan type 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the type of document for the inspection event where the inspection plan type 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then inspection criteria is enabled. If No, then inspection criteria isn't enabled. The default value is Yes.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionPlanType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of inspection plan. Valid values are Receiving, Inventory, Work in Process, Asset, and Resource. A list of accepted values is defined in the lookup type ORA_QA_IP_TYPES.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the inspection criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the inspection criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "type":"string",
            "description":"Value that identifies the locator within the subinventory. This attribute is required where inspection plan type is Inventory. This is optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the operation for this item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OperationCodeMeaning":{
            "maxLength":480,
            "type":"string",
            "description":"Value that identifies the operation that the item is associated to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OperationSequenceNumber":{
            "type":"integer",
            "description":"Sequence number of the work order operation that occurs during manufacturing inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUCode":{
            "type":"string",
            "description":"Abbreviation that identifies the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "type":"string",
            "description":"Value that identifies the source organization. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that requested the item. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the source organization. This attribute is required where inspection plan type is Receiving and DocumentType is In-transit shipment or Transfer order.",
            "nullable":true,
            "x-queryable":false
        },
        "SubinventoryCode":{
            "title":"Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory. This attribute is required where inspection plan type is Inventory.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory. This attribute is required where inspection plan type is Inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier. This attribute is required where inspection plan type is Receiving and document type is Purchase order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who supplies the material to inspect. This attribute is required where inspection plan type is Receiving and document type is Purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "type":"string",
            "description":"Value that identifies the supplier site. This attribute is required where inspection plan type is Receiving, document type is Purchase order for the specified supplier. This is optional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site. This attribute is required where inspection plan type is Receiving and document type is Purchase order for the specified supplier. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkDefinitionNameId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderSubTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work order subtype code. This attribute is applicable where inspection plan type is Asset. This is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderSubTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the work order subtype. 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkOrderTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update one criterion.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/inspectionPlans/InspectionPlanId/child/criteria/IpCriteriaId"

Example 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 updates.

{
  "SourceOrganization": "M3"
}

Example 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": "M3",
  "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"
  }]
}

Back to Top