1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Qualification Requirements

Get one qualification requirement

get

/fscmRestApi/resources/11.13.18.05/assetQualificationRequirements/{RequirementId}

Request

Path Parameters
  • Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is read-only.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : assetQualificationRequirements-item-response
Type: object
Show Source
  • Default Value: true
    Contains one of the following values: true or false. If true, then the qualification profile is created automatically along with the requirement. If false, then the qualification profile is not created automatically along with the requirement. This attribute value is set during the creation of the qualification requirement. The attribute is required and the default value is true.
  • Read Only: true
    Maximum Length: 64
    User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Default Interval
    Number that defines the interval at which the qualification requirement needs to be recorded for an asset repeatedly. This is optional attribute to create a qualification requirement
  • Title: UOM
    Maximum Length: 30
    Default Value: ORA_DAYS
    Abbreviation that identifies the unit of measure that is used for default interval. A list of accepted values is defined in the lookup type ORA_MNT_QUAL_REQ_DEFAULT_UOM. This is optional attribute to create a qualification requirement
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Name of the unit of measure used for default interval. This attribute is read-only.
  • Inspection Plans
    Title: Inspection Plans
    The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.
  • Read Only: true
    Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.
  • Title: Description
    Maximum Length: 240
    Description of the qualification requirement. This attribute provides a brief user-defined text providing information on the qualification requirement.
  • Title: End Date
    Date when the qualification requirement becomes inactive. The end date for a qualification requirement must be a future date.
  • Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is read-only.
  • Title: Name
    Maximum Length: 120
    Name of the qualification requirement. This is unique and required attribute to create a qualification requirement.
  • Title: Type
    Maximum Length: 30
    Abbreviation that uniquely identifies the qualification requirement type. This attribute is optional and its values are user defined. A list of accepted values are defined in the lookup type ORA_MNT_QUAL_REQUIREMENT_TYPE.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Name of the qualification requirement type. This is optional attribute to create a qualification requirement. This attribute is read-only.
Nested Schema : Inspection Plans
Type: array
Title: Inspection Plans
The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.
Show Source
Nested Schema : assetQualificationRequirements-inspectionPlans-item-response
Type: object
Show Source
  • Date when the inspection association becomes inactive. The end date must be a future date.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 255
    Name of the inspection plan associated with a qualification requirement. This attribute is optional.
  • 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
  • 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
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the inspection plan associated to the Qualification requirement. This attribute is read-only.
  • Read Only: true
    Maximum Length: 30
    Status code value of the inspection plan associated to the Qualification requirement. This attribute is read-only.
  • 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.
  • Read Only: true
    Maximum Length: 30
    Version of the inspection plan associated to the Qualification requirement. This attribute is read-only.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • Value that uniquely identifies the inspection plan referenced in the qualification requirement.
Links
inspectionPlans
Parameters:
  • RequirementId: $request.path.RequirementId
The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.
Back to Top

Examples

This example describes how to get one qualification requirement.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/RequirementId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetQualificationRequirements/300100584862551"

Example Response Body

The following example includes the contents 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"
        }
    ]
}
Back to Top