1. REST API for Oracle Fusion Cloud SCMREST API for Oracle Fusion Cloud SCM
  2. Use Cases
  3. Maintenance
  4. Create and Update Qualification Requirements

Create and Update Qualification Requirements

You can use Oracle Fusion Cloud Maintenance to define an asset number for an equipment resource instance and specify an equipment qualification requirement. For example, you can create a qualification requirement for calibration to check the calibration status. An equipment profile is automatically created based on the equipment qualification requirement. Then, you can add the qualification requirement that belongs to the qualification profile and its details to an asset number. This qualification detail is accessible from both the asset record and the resource instance record. You can view the asset qualifications for a history of qualifications with the last qualified date, qualified by, and the next qualification date.

You can associate a quality inspection plan to the qualification requirement. The asset is qualified for a given qualification requirement based on the inspection performed on the asset in a maintenance work order.

You can perform the inspection on the asset in any maintenance organization. If the inspection plan is associated with the qualification requirement in the maintenance organization, the asset qualification is automatically recorded based on the inspection performed.

Note:

You can associate only one inspection plan with one maintenance organization.
The Qualification Requirements Solution includes these REST APIs:
  • Qualification Requirements
  • Inspection Plans

Qualification Requirements

The Qualification Requirements REST API supports these methods:

  • POST: to create a new qualification requirement.
  • PATCH: to update attributes in the header and child.
  • GET: to get one or all qualification requirements.

This use case discusses the following scenarios for qualification requirements:

  • Create a qualification requirement with an automatic qualification profile.
  • Create a qualification requirement without an automatic qualification profile.
  • Create a qualification requirement with an inspection plan.

Note:

Before you create a qualification requirement, items used to create enterprise assets must be setup in Oracle Product Information Management.

Create a Qualification Requirement with an Automatic Qualification Profile

In this scenario, you create a qualification requirement with a qualification profile that has the same name as the qualification requirement by setting the AutocreateQualificationProfileFlag value to "true".

Example URL

Use this resource URL format.

POST

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

Example Request

Here's an example of the request body in JSON format.

{
"RequirementName": "ALMAutoQualReqName",
"RequirementCode": "ALMAutoQualReqCode",
"RequirementDescription": "ALMAutoQualReqDesc",
"AutocreateQualificationProfileFlag": true,
"DefaultInterval": 10,
"DefaultIntervalUOMCode": "ORA_DAYS",
"RequirementEndDate": null
}

Example Response

Here's an example of the response body in JSON format.

{
    "RequirementId": 300100584862551,
    "RequirementName": "ALMQualReqName",
    "RequirementCode": "ALMQualReqCode",
    "RequirementDescription": "ALMQualReqDesc",
    "RequirementTypeCode": null,
    "RequirementTypeName": null,
    "AutocreateQualificationProfileFlag": false,
    "DefaultInterval": 10,
    "DefaultIntervalUOMCode": "ORA_DAYS",
    "DefaultIntervalUOMName": null,
    "RequirementEndDate": null,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2023-05-05T10:49:51+00:00",
    "LastUpdateDate": "2023-05-05T10:49:52.207+00:00",
    "LastUpdateLogin": "FACC879A1F001F8CE0537AA8F00AA5D9",
    "LastUpdatedBy": "SCMOPERATIONS",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551",
            "name": "assetQualificationRequirements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551",
            "name": "assetQualificationRequirements",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551/child/inspectionPlans",
            "name": "inspectionPlans",
            "kind": "collection"
        }
    ]
}

Create a Qualification Requirement without an Automatic Qualification Profile

In this scenario, you create a qualification requirement without a qualification profile by setting the AutocreateQualificationProfileFlag value to "false".

Example Request

Here's an example of the request body in JSON format.

{
"RequirementName": "ALMManualQualReqName",
"RequirementCode": "ALMManualQualReqCode",
"RequirementDescription": "ALMManualQualReqDesc",
"AutocreateQualificationProfileFlag": false,
"DefaultInterval": 10,
"DefaultIntervalUOMCode": "ORA_DAYS",
"RequirementEndDate": null
}

Example Response

Here's an example of the response body in JSON format.

{
    "RequirementId": 300100584862552,
    "RequirementName": "ALMQualReqNameManual",
    "RequirementCode": "ALMQualReqCodeManual",
    "RequirementDescription": "ALMQualReqDescManual",
    "RequirementTypeCode": null,
    "RequirementTypeName": null,
    "AutocreateQualificationProfileFlag": false,
    "DefaultInterval": 10,
    "DefaultIntervalUOMCode": "ORA_DAYS",
    "DefaultIntervalUOMName": null,
    "RequirementEndDate": null,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2023-05-05T10:49:51+00:00",
    "LastUpdateDate": "2023-05-05T10:49:52.207+00:00",
    "LastUpdateLogin": "FACC879A1F001F8CE0537AA8F00AA5D9",
    "LastUpdatedBy": "SCMOPERATIONS",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862552",
            "name": "assetQualificationRequirements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862552",
            "name": "assetQualificationRequirements",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862552/child/inspectionPlans",
            "name": "inspectionPlans",
            "kind": "collection"
        }
    ]
}

Create a Qualification Requirement with an Inspection Plan

In this scenario, you create a a qualification requirement with an inspection plan.

Example Request

Here's an example of the request body in JSON format.

{
"RequirementName": "ALMAutoQualReqName",
"RequirementCode": "ALMAutoQualReqCode",
"RequirementDescription": "ALMAutoQualReqDesc",
"AutocreateQualificationProfileFlag": true,
"DefaultInterval": 10,
"DefaultIntervalUOMCode": "ORA_DAYS",
"RequirementEndDate": null
}

Example Response

Here's an example 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": "MNT_QA",
    "LastUpdateDate": "2023-05-05T11:58:39.177+00:00",
    "LastUpdateLogin": "FACC879A1FDD1F8CE0537AA8F00AA5D9",
    "ActiveEndDate": null,
    "InspectionPlanStatusCode": "APPROVED",
    "InspectionPlanVersion": "1",
    "InspectionPlanName": "SPPlanforQPQR2",
    "InspectionPlanOrgCode": "MNTALM",
    "InspectionPlanStatus": "ASSET",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551/child/inspectionPlans/300100584871743",
            "name": "inspectionPlans",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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"
        }
    ]
}

Inspection Plans

The Inspection Plans REST API supports these methods:

  • POST: to create a new qualification.
  • PATCH: to update attributes in the header and child.
  • GET: to get single or all qualification requirements.

This use case discusses the following scenario for a Qualification Requirement Inspection plan:

  • Associate an inspection plan with a qualification requirement.

Note:

Before you associate an inspection plan with a qualification requirement, consider the following
  • A new type of inspection plan is being introduced to exclusively support Oracle Fusion Cloud Maintenance with a new inspection type called asset inspection plan type. The details of the asset type inspection plan may refer to the asset, asset group, item, or item catalog. Depending on your preference, the asset inspection plan may be optional or mandatory during the work order operation completion. Asset inspection plans must contain characteristics and criteria. An asset inspection plan criteria may be defined for any combination of work order type or sub-type of work order or work definition, operation sequence, or operation code. The asset inspection plan status must be approved.
  • You must create an Asset type inspection plan in Approved status.

Associate an Inspection Plan with a Qualification Requirement

In this scenario, you associate an inspection plan with a qualification requirement.

Example URL

Use this resource URL format.

POST

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

Example Request

Here's an example of the request body in JSON format.

{
"InspectionPlanOrgCode": "MNTALM",
"InspectionPlanName": "SPPlanforQPQR2"
}
Example Response

Here's an example 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": "MNT_QA",
    "LastUpdateDate": "2023-05-05T11:58:39.177+00:00",
    "LastUpdateLogin": "FACC879A1FDD1F8CE0537AA8F00AA5D9",
    "ActiveEndDate": null,
    "InspectionPlanStatusCode": "APPROVED",
    "InspectionPlanVersion": "1",
    "InspectionPlanName": "SPPlanforQPQR2",
    "InspectionPlanOrgCode": "MNTALM",
    "InspectionPlanStatus": "ASSET",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551/child/inspectionPlans/300100584871743",
            "name": "inspectionPlans",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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"
        }
    ]
}