Update one plan

patch

/fscmRestApi/resources/11.13.18.05/inspectionPlans/{InspectionPlanId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments in Inspection Plans
Type: array
Title: Attachments in Inspection Plans
The Attachments in Inspection Plans resource displays attachment details for the inspection plan.
Show Source
Nested Schema : Criteria in Inspection Plans
Type: array
Title: Criteria in Inspection Plans
The Criteria in Inspection Plans resource manages criteria for the inspection plan.
Show Source
Nested Schema : Specifications in Inspection Plans
Type: array
Title: Specifications in Inspection Plans
The Specifications in Inspection Plans resource manages the specifications of the inspection plan.
Show Source
Nested Schema : inspectionPlans-attachments-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 80
    Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.
  • 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.
  • 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.
  • Value that uniquely identifies the inspection plan.
  • 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.
  • Value that identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
  • Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
  • Maximum Length: 30
    Abbreviation that identifies the operation for this item.
  • Sequence number of the work order operation that occurs during manufacturing inspection.
  • Abbreviation that identifies the procurement business unit.
  • Value that uniquely identifies the procurement business unit.
  • Value that identifies the source organization. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
  • 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.
  • Title: Subinventory
    Maximum Length: 10
    Abbreviation that identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
  • Value that uniquely identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
  • Maximum Length: 255
    Name of the supplier. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
  • Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
  • 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.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.
  • 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 : schema
Type: object
Show Source
Nested Schema : Specification Attachments in Inspection Plans
Type: array
Title: Specification Attachments in Inspection Plans
The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.
Show Source
Nested Schema : inspectionPlans-specifications-attachments-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : Attachments in Inspection Plans
Type: array
Title: Attachments in Inspection Plans
The Attachments in Inspection Plans resource displays attachment details for the inspection plan.
Show Source
Nested Schema : Criteria in Inspection Plans
Type: array
Title: Criteria in Inspection Plans
The Criteria in Inspection Plans resource manages criteria for the inspection plan.
Show Source
Nested Schema : Specifications in Inspection Plans
Type: array
Title: Specifications in Inspection Plans
The Specifications in Inspection Plans resource manages the specifications of the inspection plan.
Show Source
Nested Schema : inspectionPlans-attachments-item-response
Type: object
Show Source
Nested Schema : inspectionPlans-criteria-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the inspection criteria record.
  • Read Only: true
    Date when the user created the inspection criteria.
  • Value that uniquely identifies the inspection plan criteria.
  • Maximum Length: 80
    Status of the dispatch in the work order operation. A list of accepted values include Ready and Reject.
  • 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.
  • 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.
  • Value that uniquely identifies the inspection plan.
  • 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.
  • Read Only: true
    Date and time when the user most recently updated the inspection criteria.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the inspection criteria.
  • Links
  • Value that identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
  • Value that uniquely identifies the locator within the subinventory. This attribute is required where InspectionPlanType is Inventory. This is optional.
  • Maximum Length: 30
    Abbreviation that identifies the operation for this item.
  • Sequence number of the work order operation that occurs during manufacturing inspection.
  • Abbreviation that identifies the procurement business unit.
  • Value that uniquely identifies the procurement business unit.
  • Value that identifies the source organization. This attribute is required where InspectionPlanType is Receiving and DocumentType is In-transit shipment or Transfer order.
  • 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.
  • Title: Subinventory
    Maximum Length: 10
    Abbreviation that identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
  • Value that uniquely identifies the subinventory. This attribute is required where InspectionPlanType is Inventory.
  • Maximum Length: 255
    Name of the supplier. This attribute is required where InspectionPlanType is Receiving and DocumentType is Purchase order.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Value that identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
  • Value that uniquely identifies the work definition name. This attribute is applicable where inspection plan type is Asset. This is optional.
  • 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.
  • 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.
  • Maximum Length: 30
    Abbreviation that identifies the type of work order. This attribute is applicable where inspection plan type is Asset.This is optional.
  • 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 : inspectionPlans-specifications-item-response
Type: object
Show Source
Nested Schema : Specification Attachments in Inspection Plans
Type: array
Title: Specification Attachments in Inspection Plans
The Specification Attachments in Inspection Plans resource displays attachment details for the specifications of the inspection plan.
Show Source
Nested Schema : inspectionPlans-specifications-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to update one plan.

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"

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.

{ 
  "Description" : "latest version"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "InspectionPlanId": 300100152744368,
  "OrganizationId": 204,
  "VersionNumber": "1",
  "Name": "RCV-Demo007",
  "Description": "latest version",
  "InspectionPlanType": "RECEIVING",
  "InspectionPlanStatus": "NEW",
  "EnabledFlag": true,
  "EffectiveStartDate": "2018-01-23T09:08:38+00:00",
  "EffectiveEndDate": null,
  "InspectionLevelId": 300100151902438,
  "InventoryItemId": 149,
  "Revision": null,
  "CategorySetId": null,
  "CategoryId": null,
  "WorkCenterId": null,
  "ResourceId": null,
  "Owner": "QUALITY_ENGINEER",
  "OptionalFlag": false,
  "Approver": null,
  "OrganizationCode": "V1",
  "WorkCenter": null,
  "ResourceName": null,
  "ItemNumber": "AS54888",
  "CatalogName": null,
  "CategoryName": null,
  "InspectionLevelName": "25% level w Sampling no Skip Lots",
  "InspectionLevelDescription": "25% level w Sampling no Skip Lots",
  "CreatedBy": "QUALITY_ENGINEER",
  "CreationDate": "2018-07-02T07:40:18+00:00",
  "LastUpdateDate": "2018-07-02T07:48:45+00:00",
  "LastUpdateLogin": "6FFF203DFC3A7766E05368BFF20A59EB",
  "LastUpdatedBy": "QUALITY_ENGINEER",
  "links": [{
    "rel": "self",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368",
    "name": "inspectionPlans",
    "kind": "item",
    "properties": {
      "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "rel": "canonical",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368",
    "name": "inspectionPlans",
    "kind": "item"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/ItemNumberLOV",
    "name": "ItemNumberLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/InspectionPlanStatusLOV",
    "name": "InspectionPlanStatusLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/InspectionPlanTypeLOV",
    "name": "InspectionPlanTypeLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/CatalogLOV",
    "name": "CatalogLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/OrganizationCodeLOV",
    "name": "OrganizationCodeLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/InspectionLevelLOV",
    "name": "InspectionLevelLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/OwnerLOV",
    "name": "OwnerLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/ItemRevisionLOV",
    "name": "ItemRevisionLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/CategoryLOV",
    "name": "CategoryLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/WorkCenterLOV",
    "name": "WorkCenterLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/ApproverLOV",
    "name": "ApproverLOV",
    "kind": "collection"
  }, {
    "rel": "lov",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/lov/ResourceCodeLOV",
    "name": "ResourceCodeLOV",
    "kind": "collection"
  }, {
    "rel": "child",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/criteria",
    "name": "criteria",
    "kind": "collection"
  }, {
    "rel": "child",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/specifications",
    "name": "specifications",
    "kind": "collection"
  }, {
    "rel": "child",
    "href": "https://servername/fscmRestApi/resources/version/inspectionPlans/300100152744368/child/planAttachments",
    "name": "planAttachments",
    "kind": "collection"
  }]
}
Back to Top