1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Initiatives
  4. Qualification Areas for Supplier Initiatives

Get all qualification areas

get

/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{supplierInitiativesUniqID}/child/qualificationAreas

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Initiatives resource and used to uniquely identify an instance of Initiatives. The client should not generate the hash key value. Instead, the client should query on the Initiatives collection resource in order to navigate to a specific instance of Initiatives to get the hash key.
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>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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 qualification areas according to qualification area identifier.
      Finder Variables
      • InitiativeQualificationAreaId; integer; Value that uniquely identifies the qualification area.
  • 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:
    • InitiativeQualificationAreaId; integer; Value that uniquely identifies the qualification area.
    • OwnerName; string; Value that uniquely identifies the name of the qualification area owner.
    • QualAreaLevel; string; Value that identifies whether the area is relevant to a supplier or to a supplier site.
    • QualAreaLevelCode; string; Abbreviation that identifies whether the area is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : supplierInitiatives-qualificationAreas
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierInitiatives-qualificationAreas-item-response
Type: object
Show Source
  • Title: Display Sequence
    Display sequence of the qualification area added to a qualification kind of initiative.
  • Title: Qualification Evaluation Due Date
    Date when the qualification was due for evaluation.
  • Read Only: true
    Maximum Length: 255
    Indicates that there is an inactive question in the initiative's qualification area.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a qualification based on this qualification area will be evaluated or will be used for information only purposes. If false, then the qualification won't be used for information only process. The default value is false.
  • Value that uniquely identifies the qualification area.
  • Links
  • Value that uniquely identifies the original qualification area.
  • Title: Owner
    Maximum Length: 240
    Name of the qualification area owner.
  • Value that uniquely identifies the name of the qualification area owner.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Value that uniquely identifies the name of the qualification area owner.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Value that identifies whether the area is relevant to a supplier or to a supplier site.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies whether the area is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Qualification Area
    Maximum Length: 80
    Name of the qualification area entered by the user.
  • Title: Description
    Read Only: true
    Maximum Length: 1000
    Description of the qualification area entered by user.
  • Value that uniquely identifies the qualification area.
  • Title: Revision
    Read Only: true
    Number that identifies the current version of the qualification area definition.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the qualification area.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the qualification area. Accepted values are defined in the lookup type POQ_QUAL_AREA_STATUS. To review the available values, use the Setup and Maintenance work area and the Manage Standard Lookups task.
  • Title: Synchronization Check
    Maximum Length: 1
    A value that indicates whether the acceptable response to a supplier attribute question is synchronized with the supplier profile. It can be either true or false. If true, the synchronization check has passed for the qualification area. If false, the synchronization check has failed. This attribute doesn't have a default value.
Back to Top

Examples

This example describes how to get all qualification areas.

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/supplierInitiatives/InitiativeId/child/qualificationAreas"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "items": [
    {
      "InitiativeQualificationAreaId": 300100194001376,
      "SyncCheckFlag": true,
      "QualificationAreaId": 300100194001273,
      "QualificationArea": "Construction Material Requirements",
      "OwnerId": 100010026863783,
      "Owner": "Jones,Clare",
      "OriginalQualificationAreaId": 300100194001273,
      "EvaluationDueDate": "2020-02-19",
      "QualificationAreaDescription": null,
      "QualificationAreaRevision": 0,
      "QualificationAreaStatusCode": "ACTIVE",
      "QualificationAreaStatus": "Active",
      "DisplaySequence": 10,
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001376",
          "name": "qualificationAreas",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001376",
          "name": "qualificationAreas",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373",
          "name": "supplierInitiatives",
          "kind": "item"
        }
      ]
    },
    {
      "InitiativeQualificationAreaId": 300100194001381,
      "SyncCheckFlag": true,
      "QualificationAreaId": 300100194001368,
      "QualificationArea": "Heavy Electricals Requirements",
      "OwnerId": 100010026864135,
      "Owner": "Antilla,Penelope",
      "OriginalQualificationAreaId": 300100194001368,
      "EvaluationDueDate": "2020-02-29",
      "QualificationAreaDescription": null,
      "QualificationAreaRevision": 0,
      "QualificationAreaStatusCode": "ACTIVE",
      "QualificationAreaStatus": "Active",
      "DisplaySequence": 20,
      "links": [
        {
          "rel": "self",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001381",
          "name": "qualificationAreas",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001381",
          "name": "qualificationAreas",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373",
          "name": "supplierInitiatives",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas",
      "name": "qualificationAreas",
      "kind": "collection"
    }
  ]
}
Back to Top