Jump to

• Request
• Response
• Examples

Update one inspection plan in a requirement

patch

/fscmRestApi/resources/11.13.18.05/assetQualificationRequirements/{RequirementId}/child/inspectionPlans/{RequirementInspectionId}

Request

Path Parameters

• RequirementId(required): integer(int64)
  Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is read-only.
• RequirementInspectionId(required): integer(int64)
  Value that uniquely identifies the inspection plan referenced in the qualification requirement.

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

• ActiveEndDate: string (date-time)
  Date when the inspection association becomes inactive. The end date must be a future date.
• InspectionPlanName: string
  Maximum Length: 255

  Name of the inspection plan associated with a qualification requirement. This attribute is optional.
• InspectionPlanOrgCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only
• RequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement for each inspection plan. You can create only one relationship between each value that is specified by RequirementInspectionId and RequirementId.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the inspection association becomes inactive. The end date must be a future date.",
            "format":"date-time",
            "nullable":true
        },
        "InspectionPlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection plan associated with a qualification requirement. This attribute is optional.",
            "nullable":true
        },
        "InspectionPlanOrgCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the  organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only",
            "nullable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement for each inspection plan. You can create only one relationship between each value that is specified by RequirementInspectionId and RequirementId.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : assetQualificationRequirements-inspectionPlans-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the inspection association becomes inactive. The end date must be a future date.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who associated the inspection plan to a qualification requirement The application automatically sets this value during creation. This attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  Date when the inspection plan is associated with a qualification requirement. The application automatically sets this value during creation. This attribute is read-only.
• InspectionPlanId: integer (int64)
  Value that uniquely identifies the inspection plan that is associated with a qualification requirement. One inspection plan per organization can be added to a qualification requirement. This attribute is optional.
• InspectionPlanName: string
  Maximum Length: 255

  Name of the inspection plan associated with a qualification requirement. This attribute is optional.
• InspectionPlanOrgCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only
• InspectionPlanOrgId: integer (int64)
  Value that uniquely identifies the organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only
• InspectionPlanStatus: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the inspection plan associated to the Qualification requirement. This attribute is read-only.
• InspectionPlanStatusCode: string
  Read Only: true

  Maximum Length: 30

  Status code value of the inspection plan associated to the Qualification requirement. This attribute is read-only.
• InspectionPlanType: string
  Read Only: true

  Maximum Length: 30

  Name of the inspection plant type associated with a qualification requirement. Only work in process type can be associated with a qualification requirement. This attribute is read-only.
• InspectionPlanVersion: string
  Read Only: true

  Maximum Length: 30

  Version of the inspection plan associated to the Qualification requirement. This attribute is read-only.
• LastUpdateDate: string (date-time)
  Read Only: true

  Login that the user used when updating the inspection plan association to a qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the user most recently updated the inspection plan association to a qualification requirement. The application automatically sets this value during creation. This attribute is read-only.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User who most recently updated the inspection plan association to a qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptionalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the inspection results entry is optional in the maintenance work order. If false, then the inspection results entry is mandatory in the maintenance work order. This attribute value is set during the creation of the inspection plan. This attribute is read-only.
• RequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement for each inspection plan. You can create only one relationship between each value that is specified by RequirementInspectionId and RequirementId.
• RequirementInspectionId: integer (int64)
  Value that uniquely identifies the inspection plan referenced in the qualification requirement.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the inspection association becomes inactive. The end date must be a future date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who associated the inspection plan to a qualification requirement The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the inspection plan is associated with a qualification requirement. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan that is associated with a qualification requirement. One inspection plan per organization can be added to a qualification requirement. This attribute is optional.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionPlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection plan associated with a qualification requirement. This attribute is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPlanOrgCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the  organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionPlanOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in which the inspection plan is used. This attribute value is set during the creation of the inspection plan. This attribute is read-only",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionPlanStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the inspection plan associated to the Qualification requirement. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code value of the inspection plan associated to the Qualification requirement. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanType":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the inspection plant type associated with a qualification requirement. Only work in process type can be associated with a qualification requirement. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanVersion":{
            "maxLength":30,
            "type":"string",
            "description":"Version of the inspection plan associated to the Qualification requirement. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Login that the user used when updating the inspection plan association to a qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"User who most recently updated the inspection plan association to a qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the user most recently updated the inspection plan association to a qualification requirement. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the inspection results entry is optional in the maintenance work order. If false, then the inspection results entry is mandatory in the maintenance work order. This attribute value is set during the creation of the inspection plan. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement for each inspection plan. You can create only one relationship between each value that is specified by RequirementInspectionId and RequirementId.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementInspectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inspection plan referenced in the qualification requirement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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 inspection plan of the qualification requirement.

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/assetQualificationRequirements/RequirementId/child/inspectionPlans/RequirementInspectionId"

For example:

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

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.

{
   "ActiveEndDate": "2024-06-05T11:58:39+00:00"
}

Example Response Body

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

{
    "RequirementInspectionId": 300100584871743,
    "RequirementId": 300100584862551,
    "InspectionPlanId": 300100584871740,
    "InspectionPlanType": "ASSET",
    "OptionalFlag": false,
    "InspectionPlanOrgId": 300100113363336,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2023-05-05T11:58:39+00:00",
    "LastUpdatedBy": "ALM_QA",
    "LastUpdateDate": "2023-05-05T17:41:37+00:00",
    "LastUpdateLogin": "FACC86B5C7FB1F86E0537AA8F00A5349",
    "ActiveEndDate": "2024-06-05T11:58:39+00:00",
    "InspectionPlanStatusCode": "APPROVED",
    "InspectionPlanVersion": "1",
    "InspectionPlanName": "SPPlanforQPQR2",
    "InspectionPlanOrgCode": "MNTALM",
    "InspectionPlanStatus": "Approved",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551/child/inspectionPlans/300100584871743",
            "name": "inspectionPlans",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551/child/inspectionPlans/300100584871743",
            "name": "inspectionPlans",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551",
            "name": "assetQualificationRequirements",
            "kind": "item"
        }
    ]
}

Back to Top