1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Maintenance
  4. Qualification Profiles

Get qualifications profiles

get

/fscmRestApi/resources/11.13.18.05/assetQualificationProfiles

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the qualification profile according to the qualification profile identifier.
      Finder Variables:
      • ProfileId; integer; Value that uniquely identifies the qualification profile.
    • ProfilesByRequirement: Finds all qualification profiles that are associated with a given qualification requirement identifier.
      Finder Variables:
      • BindRequirementCode; string; Finds all qualification profiles associated with a qualification requirement based on the requirement code.
      • BindRequirementId; integer; Finds all qualification profiles associated with a qualification requirement based on the requirement ID.
      • BindRequirementName; string; Finds all qualification profiles associated with a qualification requirement based on the requirement name.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; User who created the qualification profile The application automatically sets this value during creation. This attribute is read-only.
    • CreationDate; string; Date when the qualification profile is created. The application automatically sets this value during creation. This attribute is read-only.
    • LastUpdateDate; string; Login that the user used when updating the qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
    • LastUpdateLogin; string; User who most recently updated the qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
    • LastUpdatedBy; string; Date when the user most recently updated the qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
    • ProfileCategoryCode; string; Abbreviation that uniquely identifies the qualification profile category. This attribute is optional and its values are user-defined. A list of accepted values are defined in the lookup type ORA_MNT_QUAL_PROFILE_CATEGORY.
    • ProfileCategoryName; string; Name of the qualification profile category. This is an optional attribute to create a qualification profile. This attribute is read-only.
    • ProfileCode; string; Abbreviation that uniquely identifies the qualification profile. This attribute is required to create a qualification profile.
    • ProfileDescription; string; Description of the qualification profile. This attribute provides a brief user-defined text providing information on the qualification profile.
    • ProfileEndDate; string; Date when the qualification profile becomes inactive. The end date for a qualification profile must be a future date.
    • ProfileId; integer; Value that uniquely identifies the qualification profile. The application creates this value when it creates the qualification profile. This attribute is read-only.
    • ProfileName; string; Name of the qualification profile. This is a unique attribute required to create a qualification profile.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : assetQualificationProfiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetQualificationProfiles-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the qualification profile The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the qualification profile is created. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Login that the user used when updating the qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    Date when the user most recently updated the qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    User who most recently updated the qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
  • Links
  • Title: Category
    Maximum Length: 30
    Abbreviation that uniquely identifies the qualification profile category. This attribute is optional and its values are user-defined. A list of accepted values are defined in the lookup type ORA_MNT_QUAL_PROFILE_CATEGORY.
  • Read Only: true
    Maximum Length: 255
    Name of the qualification profile category. This is an optional attribute to create a qualification profile. This attribute is read-only.
  • Title: Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the qualification profile. This attribute is required to create a qualification profile.
  • Title: Description
    Maximum Length: 240
    Description of the qualification profile. This attribute provides a brief user-defined text providing information on the qualification profile.
  • Title: End Date
    Date when the qualification profile becomes inactive. The end date for a qualification profile must be a future date.
  • Value that uniquely identifies the qualification profile. The application creates this value when it creates the qualification profile. This attribute is read-only.
  • Title: Name
    Maximum Length: 120
    Name of the qualification profile. This is a unique attribute required to create a qualification profile.
  • Qualification Requirements
    Title: Qualification Requirements
    The Qualification Requirements resource manages the qualification requirements required for a qualification profile. You can add, update, and view the list of qualification requirements.
Nested Schema : Qualification Requirements
Type: array
Title: Qualification Requirements
The Qualification Requirements resource manages the qualification requirements required for a qualification profile. You can add, update, and view the list of qualification requirements.
Show Source
Nested Schema : assetQualificationProfiles-qualificationRequirements-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who associated the qualification requirement with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
  • Read Only: true
    Date when the qualification requirement is associated with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
  • Read Only: true
    Login that the user used when updating the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    Date when the user most recently updated the qualification requirement association with a qualification profile. The application automatically sets this value while creating the profile. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    User who most recently updated the qualification requirement association with a qualification profile. The application assigns a value to this attribute while creating the profile. This attribute is read-only.
  • Links
  • Value that uniquely identifies the qualification requirement referenced in the qualification profile.
  • Title: Code
    Maximum Length: 255
    Abbreviation that uniquely identifies the qualification requirement associated with a qualification profile. This attribute is read-only.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the qualification requirement associated with the qualification profile. This attribute provides brief user-defined text, providing information on the qualification requirement. This attribute is read-only.
  • Title: End Date
    Date when the relationship between qualification requirement and qualification profile becomes inactive. The end date for the relationship must be a future date.
  • Value that uniquely identifies the qualification requirement that's associated with the qualification profile. This attribute is required when adding the qualification requirement to a qualification profile.
  • Title: Name
    Maximum Length: 255
    Name of the qualification requirement associated with a qualification profile. This attribute is read-only.
Back to Top

Examples

This example describes how to get all qualifications profiles.

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/assetQualificationProfiles"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
       
        {
            "ProfileId": 300100577269001,
            "ProfileName": "SPPROFILE1",
            "ProfileCode": "SPPROFILE1",
            "ProfileDescription": "SPPROFILE1",
            "ProfileCategoryCode": null,
            "ProfileCategoryName": null,
            "ProfileEndDate": "2023-04-30",
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-03-24T04:23:37+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-03-24T04:27:29+00:00",
            "LastUpdateLogin": "F6CD3A6FEEE5952DE0537AA8F00A1243",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100577269001",
                    "name": "assetQualificationProfiles",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100577269001",
                    "name": "assetQualificationProfiles",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100577269001/child/qualificationRequirements",
                    "name": "qualificationRequirements",
                    "kind": "collection"
                }
            ]
        },
        {
            "ProfileId": 300100584871824,
            "ProfileName": "ALMQualProfile2",
            "ProfileCode": "ALMQualProfileCode",
            "ProfileDescription": "ALMQualProfile2Description",
            "ProfileCategoryCode": null,
            "ProfileCategoryName": null,
            "ProfileEndDate": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-05-05T13:25:35+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-05-05T13:25:35.069+00:00",
            "LastUpdateLogin": "FACC9299451C1F90E0537AA8F00A19AC",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871824",
                    "name": "assetQualificationProfiles",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871824",
                    "name": "assetQualificationProfiles",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles/300100584871824/child/qualificationRequirements",
                    "name": "qualificationRequirements",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetQualificationProfiles",
            "name": "assetQualificationProfiles",
            "kind": "collection"
        }
    ]
}
Back to Top