Jump to

• Request
• Response
• Examples

Create qualification requirements

post

/fscmRestApi/resources/11.13.18.05/assetQualificationRequirements

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AutocreateQualificationProfileFlag: boolean
  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.
• DefaultInterval: number
  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
• DefaultIntervalUOMCode: string
  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
• inspectionPlans: array 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.
• RequirementCode(required): string
  Title: Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.
• RequirementDescription: string
  Title: Description

  Maximum Length: 240

  Description of the qualification requirement. This attribute provides a brief user-defined text providing information on the qualification requirement.
• RequirementEndDate: string (date)
  Title: End Date

  Date when the qualification requirement becomes inactive. The end date for a qualification requirement must be a future date.
• RequirementId: 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.
• RequirementName(required): string
  Title: Name

  Maximum Length: 120

  Name of the qualification requirement. This is unique and required attribute to create a qualification requirement.
• RequirementTypeCode: string
  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.

{
    "required":[
        "RequirementCode",
        "RequirementName"
    ],
    "type":"object",
    "properties":{
        "RequirementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the qualification requirement. This attribute provides a brief user-defined text providing information on the qualification requirement.",
            "nullable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AutocreateQualificationProfileFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "inspectionPlans":{
            "title":"Inspection Plans",
            "type":"array",
            "description":"The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.",
            "items":{
                "$ref":"#/components/schemas/assetQualificationRequirements-inspectionPlans-item-post-request"
            }
        },
        "RequirementEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the qualification requirement becomes inactive. The end date for a qualification requirement must be a future date.",
            "format":"date",
            "nullable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RequirementName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create a qualification requirement.",
            "nullable":false
        },
        "RequirementCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":false
        },
        "DefaultInterval":{
            "title":"Default Interval",
            "type":"number",
            "description":"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",
            "nullable":true
        },
        "DefaultIntervalUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"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",
            "nullable":true,
            "default":"ORA_DAYS"
        }
    }
}

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

• Array of: object assetQualificationRequirements-inspectionPlans-item-post-request

{
    "title":"Inspection Plans",
    "type":"array",
    "description":"The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.",
    "items":{
        "$ref":"#/components/schemas/assetQualificationRequirements-inspectionPlans-item-post-request"
    }
}

Nested Schema : assetQualificationRequirements-inspectionPlans-item-post-request

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the inspection association becomes inactive. The end date must be a future date.
• 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
• 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":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the inspection association becomes inactive. The end date must be a future date.",
            "format":"date-time",
            "nullable":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"
            }
        }
    }
}

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-item-response

Type: object

Show Source

• AutocreateQualificationProfileFlag: boolean
  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.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.
• DefaultInterval: number
  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
• DefaultIntervalUOMCode: string
  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
• DefaultIntervalUOMName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the unit of measure used for default interval. This attribute is read-only.
• inspectionPlans: array 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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequirementCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.
• RequirementDescription: string
  Title: Description

  Maximum Length: 240

  Description of the qualification requirement. This attribute provides a brief user-defined text providing information on the qualification requirement.
• RequirementEndDate: string (date)
  Title: End Date

  Date when the qualification requirement becomes inactive. The end date for a qualification requirement must be a future date.
• RequirementId: 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.
• RequirementName: string
  Title: Name

  Maximum Length: 120

  Name of the qualification requirement. This is unique and required attribute to create a qualification requirement.
• RequirementTypeCode: string
  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.
• RequirementTypeName: string
  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the qualification requirement. This attribute provides a brief user-defined text providing information on the qualification requirement.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AutocreateQualificationProfileFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "RequirementName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create a qualification requirement.",
            "nullable":false,
            "x-queryable":true
        },
        "RequirementCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultInterval":{
            "title":"Default Interval",
            "type":"number",
            "description":"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",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultIntervalUOMName":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the unit of measure used for default interval.  This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "inspectionPlans":{
            "title":"Inspection Plans",
            "type":"array",
            "description":"The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.",
            "items":{
                "$ref":"#/components/schemas/assetQualificationRequirements-inspectionPlans-item-response"
            }
        },
        "RequirementEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the qualification requirement becomes inactive. The end date for a qualification requirement must be a future date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RequirementTypeName":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the qualification requirement type. This is optional attribute to create a qualification requirement. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultIntervalUOMCode":{
            "title":"UOM",
            "maxLength":"30",
            "type":"string",
            "description":"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",
            "nullable":true,
            "default":"ORA_DAYS",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the 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
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object assetQualificationRequirements-inspectionPlans-item-response

{
    "title":"Inspection Plans",
    "type":"array",
    "description":"The Inspection Plan resource manages the inspection plans required for qualification requirements. You can add,update and view the list of the inspection plans.",
    "items":{
        "$ref":"#/components/schemas/assetQualificationRequirements-inspectionPlans-item-response"
    }
}

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 : 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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."
        }
    }
}

Links

inspectionPlans

Operation: /fscmRestApi/resources/11.13.18.05/assetQualificationRequirements/{RequirementId}/child/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

These examples describe how to create qualification requirements.

Example cURL Command

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

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 1

This example describes how to create a qualification requirement with an automatic qualification profile.

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.

{
"RequirementName": "ALMQualReqName",
"RequirementCode": "ALMQualReqCode",
"RequirementDescription": "ALMQualReqDesc",
"AutocreateQualificationProfileFlag": true,
"DefaultInterval": 10,
"DefaultIntervalUOMCode": "ORA_DAYS"
}

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"
        }
    ]
}

Example 2

This example describes how to create a qualification requirement without an automatic qualification profile.

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.

{
"RequirementName": "ALMQualReqNameManual",
"RequirementCode": "ALMQualReqCodeManual",
"RequirementDescription": "ALMQualReqDescManual",
"AutocreateQualificationProfileFlag": false,
"DefaultInterval": 10,
"DefaultIntervalUOMCode": "ORA_DAYS"
}

Example Response Body

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

Back to Top