Jump to

• Request
• Response
• Examples

Get all areas

get

/fscmRestApi/resources/11.13.18.05/supplierQualificationAreas

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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 unique areas according to the area identifier.
    Finder Variables:
    • QualAreaId; integer; Value that uniquely identifies the area.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • ActivationDate; string; Date and time when the area is activated.
  • AutoAcceptResponsesFlag; boolean; Contains one of the following values: true or false. If true, then the responses to the questions in this qualification will be automatically accepted. If false, then automatic acceptance is disabled. The default value is false.
  • AutoEvaluateQualFlag; boolean; Contains one of the following values: true or false. If true, then the qualification created based on the qualification area will be automatically evaluated. If false, then automatic evaluation is disabled. The default value is false.
  • AutoPopulateResponsesFlag; boolean; Contains one of the following values: true or false. If true, then question responses should be defaulted from the existing responses in the response repository when responders respond to a questionnaire containing the qualification area. If false, then the responses are not defaulted. The default value is false.
  • EnableScoringFlag; boolean; Contains one of the following values: true or false. If true, then scoring is enabled on the qualification area. If false, then scoring not enabled. The default value is false.
  • ExpirationReminderPeriod; integer; Period during which the application alerts the owner about the expiration of a qualification.
  • ExpirationReminderType; string; Unit of time to indicate days, weeks, or months.
  • ExpirationReminderTypeCode; string; Abbreviation that identifies the unit of time to indicate days, weeks, and months.
  • GlobalFlag; boolean; Contains one of the following values: true or false. If true, then the set up object is globally accessible by all procurement business units. If false, then the set up object is not globally accessible. The default value is false.
  • InformationOnlyFlag; boolean; 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 will not be used for information only process. The default value is false.
  • LatestRevisionFlag; boolean; Contains one of the following values: true or false. If true, then the qualification area revision is the most recent revision. If false, then the revision of question is not the latest. The default value is false.
  • NoteToSupplier; string; Value to indicate note to the supplier about the qualification.
  • OriginalQualAreaId; integer; Value that uniquely identifies the original area.
  • Owner; string; Name of the person who owns the qualification area.
  • OwnerId; integer; Value that uniquely identifies the owner of the area.
  • ProcurementBU; string; Name of the procurement business unit that owns the qualification area.
  • ProcurementBUId; integer; Value that uniquely identifies the owning procurement business unit.
  • QualArea; string; Name of the area or identifier entered by the user.
  • QualAreaDescription; string; Description of the qualification area.
  • QualAreaId; integer; Value that uniquely identifies the area.
  • 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.
  • QualAreaStatus; string; Status of the area.
  • QualAreaStatusCode; string; Abbreviation that identifies the status of the area. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • QualificationDurationType; string; Duration for which the qualification is valid.
  • QualificationDurationTypeCode; string; Abbreviation that identifies the duration for which the qualification is valid.
  • QualificationOwnerId; integer; Value that uniquely identifies the default owner of the corresponding qualification.
  • QualificationOwnerName; string; Name of the default owner of the corresponding qualification.
  • RequalifyExpirationFlag; boolean; Contains one of the following values: true or false. If true, then the qualification automatically requalify on expiration of the corresponding qualification. If false, then do not automatically requalify. The default value is false.
  • RequalifyResponseFlag; boolean; Contains one of the following values: true or false. If true, then qualification will automatically requalify for a new response of the corresponding qualification. If false, then do not automatically requalify. The default value is false.
  • Revision; integer; Number that identifies the revision of this area. Revision 0 is the base revision.
  • SectionName; string; Name of the section that will be used in a questionnaire.
  • ShowQualInterRespFlag; boolean; Contains one of the following values: true or false. If true, then share the response of the internal responder with the corresponding supplier. If false, then do not share. The default value is false.
  • ShowQualSuppRespFlag; boolean; Contains one of the following values: true or false. If true, then share the supplier responses with the corresponding supplier. If false, then do not share. The default value is false.
  • ShowQualToSupplierFlag; boolean; Contains one of the following values: true or false. If true, then share the response summary with the corresponding supplier. If false, then do not share. The default value is false.
  • SingleQualAutoInitFlag; boolean; Contains one of the following values: true or false. If true, then the qualification area is automatically initiated with single qualification. If false, then do not automatically initiate. The default value is false.
  • StandardsOrganization; string; Value that identifies the standards organization designated as the source of this requirement.
  • StandardsOrganizationCode; string; Abbreviation that identifies the standards organization designated as the source of this requirement. A list of accepted values is defined in the lookup type POQ_STDS_ORG. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Subject; string; Value that identifies the subject to be associated with the area that is used to conduct a search.
  • SubjectCode; string; Abbreviation that identifies the subject to be associated with the area for search purposes. A list of accepted values is defined in the lookup type POQ_SUBJECT. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• totalResults: boolean
  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

• 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.

There's no request body for this operation.

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 : supplierQualificationAreas

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationAreas-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierQualificationAreas-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationAreas-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 : supplierQualificationAreas-item-response

Type: object

Show Source

• ActivationDate: string (date-time)
  Date and time when the area is activated.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• AutoAcceptResponsesFlag: boolean
  Title: Automatically accept responses

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the responses to the questions in this qualification will be automatically accepted. If false, then automatic acceptance is disabled. The default value is false.
• AutoEvaluateQualFlag: boolean
  Title: Automatically evaluate qualification

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the qualification created based on the qualification area will be automatically evaluated. If false, then automatic evaluation is disabled. The default value is false.
• AutoPopulateResponsesFlag: boolean
  Title: Automatically populate responses

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then question responses should be defaulted from the existing responses in the response repository when responders respond to a questionnaire containing the qualification area. If false, then the responses are not defaulted. The default value is false.
• businessUnits: array Business Units
  Title: Business Units

  The Business Unit resource gets the business units for a particular area.
• EnableScoringFlag: boolean
  Title: Enable scoring

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then scoring is enabled on the qualification area. If false, then scoring not enabled. The default value is false.
• ExpirationReminderPeriod: integer (int32)
  Period during which the application alerts the owner about the expiration of a qualification.
• ExpirationReminderType: string
  Title: Expiration Reminder Type

  Read Only: true

  Maximum Length: 80

  Unit of time to indicate days, weeks, or months.
• ExpirationReminderTypeCode: string
  Title: Expiration Reminder Type Code

  Maximum Length: 30

  Abbreviation that identifies the unit of time to indicate days, weeks, and months.
• GlobalFlag: boolean
  Title: Global BU access

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the set up object is globally accessible by all procurement business units. If false, then the set up object is not globally accessible. The default value is false.
• InformationOnlyFlag: boolean
  Title: Information only

  Maximum Length: 1

  Default Value: false

  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 will not be used for information only process. The default value is false.
• LatestRevisionFlag: boolean
  Title: Latest Revision

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the qualification area revision is the most recent revision. If false, then the revision of question is not the latest. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteToSupplier: string
  Title: Note to Supplier

  Maximum Length: 1000

  Value to indicate note to the supplier about the qualification.
• OriginalQualAreaId: integer (int64)
  Value that uniquely identifies the original area.
• outcomes: array Outcomes
  Title: Outcomes

  The Outcome resource gets the outcomes for a particular area.
• Owner: string
  Title: Owner

  Read Only: true

  Maximum Length: 240

  Name of the person who owns the qualification area.
• OwnerId: integer (int64)
  Title: Qualification Area Owner ID

  Value that uniquely identifies the owner of the area.
• ProcurementBU: string
  Title: Owning Procurement BU

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit that owns the qualification area.
• ProcurementBUId: integer (int64)
  Title: Owning Procurement BU ID

  Value that uniquely identifies the owning procurement business unit.
• QualArea: string
  Title: Qualification Area

  Maximum Length: 80

  Name of the area or identifier entered by the user.
• QualAreaDescription: string
  Title: Description

  Maximum Length: 1000

  Description of the qualification area.
• QualAreaId: integer (int64)
  Value that uniquely identifies the area.
• QualAreaLevel: string
  Title: Qualification Area Level

  Read Only: true

  Maximum Length: 80

  Value that identifies whether the area is relevant to a supplier or to a supplier site.
• QualAreaLevelCode: string
  Title: Qualification Area Level Code

  Maximum Length: 30

  Default Value: SUPPLIER

  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.
• QualAreaStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the area.
• QualAreaStatusCode: string
  Title: Qualification Area Status Code

  Maximum Length: 30

  Default Value: DRAFT

  Abbreviation that identifies the status of the area. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• QualAreaSurveyFlag: boolean
  Title: Internal survey

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, use responses from multiple internal responders for evaluation of the qualification. If false, then allow response from a single internal responder for evaluation of the qualification. The default value is false.
• QualificationDuration: integer (int32)
  Title: Qualification Duration

  Duration for which the qualification is valid.
• QualificationDurationType: string
  Title: Qualification Duration Type

  Read Only: true

  Maximum Length: 80

  Duration for which the qualification is valid.
• QualificationDurationTypeCode: string
  Title: Qualification Duration Type Code

  Maximum Length: 30

  Abbreviation that identifies the duration for which the qualification is valid.
• QualificationOwnerId: integer (int64)
  Title: Default Qualification Owner ID

  Value that uniquely identifies the default owner of the corresponding qualification.
• QualificationOwnerName: string
  Title: Default Qualification Owner

  Read Only: true

  Maximum Length: 240

  Name of the default owner of the corresponding qualification.
• questions: array Questions
  Title: Questions

  The Questions resource gets the questions for a particular area.
• RequalifyExpirationFlag: boolean
  Title: On qualification expiration

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the qualification automatically requalify on expiration of the corresponding qualification. If false, then do not automatically requalify. The default value is false.
• RequalifyResponseFlag: boolean
  Title: On new response

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then qualification will automatically requalify for a new response of the corresponding qualification. If false, then do not automatically requalify. The default value is false.
• Revision: integer (int32)
  Title: Revision

  Default Value: 0

  Number that identifies the revision of this area. Revision 0 is the base revision.
• SectionName: string
  Title: Section Name

  Maximum Length: 80

  Name of the section that will be used in a questionnaire.
• ShowQualInterRespFlag: boolean
  Title: Internal response

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then share the response of the internal responder with the corresponding supplier. If false, then do not share. The default value is false.
• ShowQualSuppRespFlag: boolean
  Title: Supplier response

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then share the supplier responses with the corresponding supplier. If false, then do not share. The default value is false.
• ShowQualToSupplierFlag: boolean
  Title: Share qualification with supplier

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then share the response summary with the corresponding supplier. If false, then do not share. The default value is false.
• SingleQualAutoInitFlag: boolean
  Title: Automatic initiative with single qualification

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the qualification area is automatically initiated with single qualification. If false, then do not automatically initiate. The default value is false.
• StandardsOrganization: string
  Title: Standards Organization

  Read Only: true

  Maximum Length: 80

  Value that identifies the standards organization designated as the source of this requirement.
• StandardsOrganizationCode: string
  Title: Standards Organization Code

  Maximum Length: 30

  Abbreviation that identifies the standards organization designated as the source of this requirement. A list of accepted values is defined in the lookup type POQ_STDS_ORG. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• Subject: string
  Title: Subject

  Read Only: true

  Maximum Length: 80

  Value that identifies the subject to be associated with the area that is used to conduct a search.
• SubjectCode: string
  Title: Subject Code

  Maximum Length: 30

  Abbreviation that identifies the subject to be associated with the area for search purposes. A list of accepted values is defined in the lookup type POQ_SUBJECT. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "QualAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "NoteToSupplier":{
            "title":"Note to Supplier",
            "maxLength":"1000",
            "type":"string",
            "description":"Value to indicate note to the supplier about the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person who owns the qualification area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardsOrganizationCode":{
            "title":"Standards Organization Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the standards organization designated as the source of this requirement. A list of accepted values is defined in the lookup type POQ_STDS_ORG. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationAreas-attachments-item-response"
            }
        },
        "SingleQualAutoInitFlag":{
            "title":"Automatic initiative with single qualification",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualification area is automatically initiated with single qualification. If false, then do not automatically initiate. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationReminderTypeCode":{
            "title":"Expiration Reminder Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the unit of time to indicate days, weeks, and months.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowQualInterRespFlag":{
            "title":"Internal response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then share the response of the internal responder with the corresponding supplier. If false, then do not share. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "QualAreaSurveyFlag":{
            "title":"Internal survey",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, use responses from multiple internal responders for evaluation of the qualification. If false, then allow response from a single internal responder for evaluation of the qualification. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "StandardsOrganization":{
            "title":"Standards Organization",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the standards organization designated as the source of this requirement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoAcceptResponsesFlag":{
            "title":"Automatically accept responses",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the responses to the questions in this qualification will be automatically accepted. If false, then automatic acceptance is disabled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "questions":{
            "title":"Questions",
            "type":"array",
            "description":"The Questions resource gets the questions for a particular area.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationAreas-questions-item-response"
            }
        },
        "QualificationDurationType":{
            "title":"Qualification Duration Type",
            "maxLength":"80",
            "type":"string",
            "description":"Duration for which the qualification is valid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualAreaStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequalifyExpirationFlag":{
            "title":"On qualification expiration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualification automatically requalify on expiration of the corresponding qualification. If false, then do not automatically requalify. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "QualArea":{
            "title":"Qualification Area",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the area or identifier entered by the user.",
            "nullable":false,
            "x-queryable":true
        },
        "GlobalFlag":{
            "title":"Global BU access",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the set up object is globally accessible by all procurement business units. If false, then the set up object is not globally accessible. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Qualification Area Owner ID",
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the area.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AutoPopulateResponsesFlag":{
            "title":"Automatically populate responses",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then question responses should be defaulted from the existing responses in the response repository when responders respond to a questionnaire containing the qualification area. If false, then the responses are not defaulted. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "outcomes":{
            "title":"Outcomes",
            "type":"array",
            "description":"The Outcome resource gets the outcomes for a particular area.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationAreas-outcomes-item-response"
            }
        },
        "QualAreaDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the qualification area.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"false"
            },
            "x-queryable":true
        },
        "QualificationDuration":{
            "title":"Qualification Duration",
            "type":"integer",
            "description":"Duration for which the qualification is valid.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "QualificationOwnerName":{
            "title":"Default Qualification Owner",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the default owner of the corresponding qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionName":{
            "title":"Section Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the section that will be used in a questionnaire.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivationDate":{
            "type":"string",
            "description":"Date and time when the area is activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShowQualSuppRespFlag":{
            "title":"Supplier response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then share the supplier responses with the corresponding supplier. If false, then do not share. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Owning Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit that owns the qualification area.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Owning Procurement BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the owning procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualificationOwnerId":{
            "title":"Default Qualification Owner ID",
            "type":"integer",
            "description":"Value that uniquely identifies the default owner of the corresponding qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualAreaLevel":{
            "title":"Qualification Area Level",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies whether the area is relevant to a supplier or to a supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualAreaStatusCode":{
            "title":"Qualification Area Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the area. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":false,
            "default":"DRAFT",
            "x-queryable":true
        },
        "OriginalQualAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original area.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualAreaLevelCode":{
            "title":"Qualification Area Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"SUPPLIER",
            "x-queryable":true
        },
        "ShowQualToSupplierFlag":{
            "title":"Share qualification with supplier",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then share the response summary with the corresponding supplier. If false, then do not share. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "InformationOnlyFlag":{
            "title":"Information only",
            "maxLength":"1",
            "type":"boolean",
            "description":"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 will not be used for information only process. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the subject to be associated with the area that is used to conduct a search.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoEvaluateQualFlag":{
            "title":"Automatically evaluate qualification",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualification created based on the qualification area will be automatically evaluated. If false, then automatic evaluation is disabled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ExpirationReminderPeriod":{
            "type":"integer",
            "description":"Period during which the application alerts the owner about the expiration of a qualification.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "businessUnits":{
            "title":"Business Units",
            "type":"array",
            "description":"The Business Unit resource gets the business units for a particular area.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationAreas-businessUnits-item-response"
            }
        },
        "Revision":{
            "title":"Revision",
            "type":"integer",
            "description":"Number that identifies the revision of this area. Revision 0 is the base revision.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SubjectCode":{
            "title":"Subject Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the subject to be associated with the area for search purposes. A list of accepted values is defined in the lookup type POQ_SUBJECT. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableScoringFlag":{
            "title":"Enable scoring",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then scoring is enabled on the qualification area. If false, then scoring not enabled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "QualificationDurationTypeCode":{
            "title":"Qualification Duration Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the duration for which the qualification is valid.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationReminderType":{
            "title":"Expiration Reminder Type",
            "maxLength":"80",
            "type":"string",
            "description":"Unit of time to indicate days, weeks, or months.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LatestRevisionFlag":{
            "title":"Latest Revision",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualification area revision is the most recent revision. If false, then the revision of question is not the latest. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "RequalifyResponseFlag":{
            "title":"On new response",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then qualification will automatically requalify for a new response of the corresponding qualification. If false, then do not automatically requalify. The default value is false.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object supplierQualificationAreas-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationAreas-attachments-item-response"
    }
}

Nested Schema : Business Units

Type: array

Title: Business Units

The Business Unit resource gets the business units for a particular area.

Show Source

• Array of: object supplierQualificationAreas-businessUnits-item-response

{
    "title":"Business Units",
    "type":"array",
    "description":"The Business Unit resource gets the business units for a particular area.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationAreas-businessUnits-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 : Outcomes

Type: array

Title: Outcomes

The Outcome resource gets the outcomes for a particular area.

Show Source

• Array of: object supplierQualificationAreas-outcomes-item-response

{
    "title":"Outcomes",
    "type":"array",
    "description":"The Outcome resource gets the outcomes for a particular area.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationAreas-outcomes-item-response"
    }
}

Nested Schema : Questions

Type: array

Title: Questions

The Questions resource gets the questions for a particular area.

Show Source

• Array of: object supplierQualificationAreas-questions-item-response

{
    "title":"Questions",
    "type":"array",
    "description":"The Questions resource gets the questions for a particular area.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationAreas-questions-item-response"
    }
}

Nested Schema : supplierQualificationAreas-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Value that indicates whether the attachment is shared or not.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path where the attachment is stored.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attached file.
• UploadedFileLength: integer
  Title: File Size

  Size of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text content of the attached file.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) of the web page that is attached.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when creating the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the web page that is attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Value that indicates whether the attachment is shared or not.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path where the attachment is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Nested Schema : supplierQualificationAreas-businessUnits-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• QualAreaBUAccessId: integer (int64)
  Value that uniquely identifies the area business unit.
• QualAreaId: integer (int64)
  Value that uniquely identifies the area.
• QualificationOwnerId: integer (int64)
  Title: Qualification Owner ID

  Value that uniquely identify the default owner of the corresponding qualification.
• QualificationOwnerName: string
  Title: Qualification Owner

  Read Only: true

  Maximum Length: 240

  Name of the default owner of the corresponding qualification.

{
    "type":"object",
    "properties":{
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualificationOwnerId":{
            "title":"Qualification Owner ID",
            "type":"integer",
            "description":"Value that uniquely identify the default owner of the corresponding qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualAreaBUAccessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the area business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualificationOwnerName":{
            "title":"Qualification Owner",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the default owner of the corresponding qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : supplierQualificationAreas-outcomes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the qualification area outcome is active and is used for the evaluation process. If false, then the qualification area outcome is not active.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Order in which the outcomes are displayed to the user for this specific area.
• FromScore: integer (int32)
  Title: From Score

  Lowest score for the qualification outcome.
• KnockoutOutcomeFlag: boolean
  Title: Knockout Outcome

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then assign the outcome to the qualification if the question response score is at or below the question knockout score. If false, then do not assign the outcome. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationFlag: boolean
  Title: Notify

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then send notification of outcome for the automatically evaluated qualification. If false, then do not send notification to the Qualification Owner The default value is false.
• OutcomeName: string
  Title: Outcome

  Maximum Length: 80

  Name of the qualification area outcome. This value is set as an outcome of a qualification as part of the evaluation.
• QualAreaId: integer (int64)
  Value that uniquely identifies the area.
• QualAreaOutcomeId: integer (int64)
  Value that uniquely identify the outcome of the qualification area.
• ToScore: integer (int32)
  Title: To Score

  Highest score for the qualification outcome.

{
    "type":"object",
    "properties":{
        "QualAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ToScore":{
            "title":"To Score",
            "type":"integer",
            "description":"Highest score for the qualification outcome.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the outcomes are displayed to the user for this specific area.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "QualAreaOutcomeId":{
            "type":"integer",
            "description":"Value that uniquely identify the outcome of the qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FromScore":{
            "title":"From Score",
            "type":"integer",
            "description":"Lowest score for the qualification outcome.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NotificationFlag":{
            "title":"Notify",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then send notification of outcome for the automatically evaluated qualification. If false, then do not send notification to the Qualification Owner The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the qualification area outcome is active and is used for the evaluation process. If false, then the qualification area outcome is not active.",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "KnockoutOutcomeFlag":{
            "title":"Knockout Outcome",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then assign the outcome to the qualification if the question response score is at or below the question knockout score. If false, then do not assign the outcome. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OutcomeName":{
            "title":"Outcome",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the qualification area outcome. This value is set as an outcome of a qualification as part of the evaluation.",
            "nullable":false,
            "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 : supplierQualificationAreas-questions-item-response

Type: object

Show Source

• DisplaySequence: integer (int32)
  Title: Display Sequence

  Order in which the questions are displayed to the user for this specific area.
• KnockoutScore: integer (int32)
  Title: Knockout Score

  Value that indicates that any response score at or below the knockout score for the question will give the qualification the knockout outcome.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QualAreaId: integer (int64)
  Value that uniquely identifies the qualification area.
• QualAreaQuestionId: integer (int64)
  Value that uniquely identifies the qualification area question.
• Question: string
  Title: Question

  Read Only: true

  Maximum Length: 80

  Name of the question or an identifier entered by the user.
• QuestionId: integer (int64)
  Value that uniquely identifies the question.
• QuestionStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: DRAFT

  Status of the question.
• Weight: number
  Title: Weight

  Value that indicates the importance of the question in the qualification area. This value is used to calculate the overall score of the qualification.

{
    "type":"object",
    "properties":{
        "QualAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualAreaQuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuestionStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the question.",
            "nullable":false,
            "readOnly":true,
            "default":"DRAFT",
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the questions are displayed to the user for this specific area.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "KnockoutScore":{
            "title":"Knockout Score",
            "type":"integer",
            "description":"Value that indicates that any response score at or below the knockout score for the question will give the qualification the knockout outcome.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Question":{
            "title":"Question",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the question or an identifier entered by the user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Value that indicates the importance of the question in the qualification area. This value is used to calculate the overall score of the qualification.",
            "nullable":true,
            "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"
    }
}

Back to Top

Examples

This example describes how to get all 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/supplierQualificationAreas"

Example Response Body

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

{
	"items": [
	{
		"QualAreaId": 300100194547517,
		"OriginalQualAreaId": 300100194547517,
		"Revision": 0,
		"QualArea": "Financial Viability",
		"QualAreaDescription": "Financial Viability",
		"QualAreaStatus": "Active",
		"QualAreaStatusCode": "ACTIVE",
		"GlobalFlag": true,
		"InformationOnlyFlag": false,
		"LatestRevisionFlag": true,
		"QualAreaLevelCode": "SUPPLIER",
		"QualAreaLevel": "Supplier or supplier site",
		"ProcurementBUId": 204,
		"ProcurementBU": "Vision Operations",
		"OwnerId": 100010026863783,
		"Owner": "Clare Smith",
		"SubjectCode": null,
		"Subject": null,
		"StandardsOrganizationCode": null,
		"StandardsOrganization": null,
		"ActivationDate": "2020-05-11T14:41:15.877+00:00",
		"EnableScoringFlag": true,
		"AutoAcceptResponsesFlag": true,
		"AutoPopulateResponsesFlag": true,
		"AutoEvaluateQualFlag": true,
		"ExpirationReminderTypeCode": "DAYS",
		"ExpirationReminderType": "Days",
		"ExpirationReminderPeriod": null,
		"RequalifyExpirationFlag": false,
		"QualificationDurationTypeCode": "MONTHS",
		"QualificationDurationType": "Months",
		"QualificationDuration": null,
		"ShowQualToSupplierFlag": false,
		"ShowQualSuppRespFlag": null,
		"ShowQualInterRespFlag": false,
		"NoteToSupplier": null,
		"RequalifyResponseFlag": null,
		"SingleQualAutoInitFlag": null,
		"QualificationOwnerId": null,
		"QualificationOwnerName": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517",
			"name": "supplierQualificationAreas",
			"kind": "item",
			"properties": {
				"changeIndicator": 
				...
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517",
			"name": "supplierQualificationAreas",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517/child/businessUnits",
			"name": "businessUnits",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517/child/outcomes",
			"name": "outcomes",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194547517/child/questions",
			"name": "questions",
			"kind": "collection"
		}
		]
	},
	{
		"QualAreaId": 300100194559453,
		"OriginalQualAreaId": 300100194559453,
		"Revision": 0,
		"QualArea": "Compliance and Ethics",
		"QualAreaDescription": null,
		"QualAreaStatus": "Active",
		"QualAreaStatusCode": "ACTIVE",
		"GlobalFlag": true,
		"InformationOnlyFlag": false,
		"LatestRevisionFlag": true,
		"QualAreaLevelCode": "SUPPLIER",
		"QualAreaLevel": "Supplier or supplier site",
		"ProcurementBUId": 204,
		"ProcurementBU": "Vision Operations",
		"OwnerId": 100010026863783,
		"Owner": "Clare Smith",
		"SubjectCode": null,
		"Subject": null,
		"StandardsOrganizationCode": null,
		"StandardsOrganization": null,
		"ActivationDate": "2020-05-11T23:34:46.913+00:00",
		"EnableScoringFlag": false,
		"AutoAcceptResponsesFlag": true,
		"AutoPopulateResponsesFlag": true,
		"AutoEvaluateQualFlag": false,
		"ExpirationReminderTypeCode": "DAYS",
		"ExpirationReminderType": "Days",
		"ExpirationReminderPeriod": null,
		"RequalifyExpirationFlag": false,
		"QualificationDurationTypeCode": "MONTHS",
		"QualificationDurationType": "Months",
		"QualificationDuration": null,
		"ShowQualToSupplierFlag": false,
		"ShowQualSuppRespFlag": null,
		"ShowQualInterRespFlag": false,
		"NoteToSupplier": null,
		"RequalifyResponseFlag": null,
		"SingleQualAutoInitFlag": null,
		"QualificationOwnerId": null,
		"QualificationOwnerName": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453",
			"name": "supplierQualificationAreas",
			"kind": "item",
			"properties": {
				"changeIndicator": 
				...
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453",
			"name": "supplierQualificationAreas",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453/child/businessUnits",
			"name": "businessUnits",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453/child/outcomes",
			"name": "outcomes",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas/300100194559453/child/questions",
			"name": "questions",
			"kind": "collection"
		}
		]
	},
	...
	],
	"count": 25,
	"hasMore": true,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/supplierQualificationAreas",
		"name": "supplierQualificationAreas",
		"kind": "collection"
	}
	]
}

Back to Top