Jump to

• Request
• Response
• Examples

Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.

post

/fscmRestApi/resources/11.13.18.05/supplierQualificationModels

Request

Header Parameters

• Effective-Of: string
  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.
• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActivationDate: string (date-time)
  Date and time when the model is activated.
• areas: array Qualification Model Areas
  Title: Qualification Model Areas

  A grouping of areas associated with a particular qualification model.
• AssessmentOwnerId: integer (int64)
  Value that uniquely identifies the owner of the model.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• AutoEvaluateAssessmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment created based on the qualification model will be automatically evaluated. If false, automatic evaluation is disabled. The default value is false.
• businessUnits: array Qualification Model Business Units
  Title: Qualification Model Business Units

  A set of business units associated with a particular qualification model.
• DefaultAssessmtOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the model's default owner becomes the assessment owner. The default value is false.
• EnableScoringFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, scoring is enabled on the qualification model. If false, scoring isn't enabled. The default value is false.
• ExpirationReminderPeriod: integer (int32)
  Period during which the application alerts the owner about the expiration of an assessment.
• ExpirationReminderTypeCode: string
  Maximum Length: 30

  Unit of time to indicate days, weeks, or months.
• GlobalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the setup object is globally accessible by all procurement business units. If false, the setup object isn't globally accessible. The default value is false.
• LatestRevisionFlag: boolean
  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, the qualification area revision is the most recent. If false, the revision of the question isn't the latest. The default value is false.
• NoteToSupplier: string
  Maximum Length: 1000

  Value indicating a note to the supplier about the assessment.
• OriginalQualModelId: integer (int64)
  Value that uniquely identifies the original model.
• outcomes: array Qualification Model Outcomes
  Title: Qualification Model Outcomes

  A set of outcomes associated with a particular qualification model.
• OwnerId: integer (int64)
  Value that uniquely identifies the owner of the model.
• ProcurementBUId(required): integer (int64)
  Value that uniquely identifies the owning procurement business unit.
• QualModel(required): string
  Maximum Length: 80

  Name of the qualification model.
• QualModelDescription: string
  Maximum Length: 240

  Description of the qualification model.
• QualModelLevelCode: string
  Maximum Length: 30

  Default Value: SUPPLIER

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• QualModelUsageCode: string
  Maximum Length: 30

  Value that uniquely identifies whether the record is for a qualification model or checklist.
• ReassessQualificationFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment needs to be reassessed upon the creation of a new qualification. The default value is false.
• Revision: integer (int32)
  Default Value: 0

  Number that identifies the revision of this model. Revision 0 is the base revision.
• ShareEligibilityFlag: boolean
  Maximum Length: 1

  Default Value: false

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• ShowAssessmentQualFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment's qualifications are shared with the supplier along with the assessment details. The default value is false.
• ShowAssessmtToSuppFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the response summary is shared with the corresponding supplier. If false, it's not shared. The default value is false.
• SourcingEligibilityFlag: boolean
  Maximum Length: 1

  Default Value: false

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• StatusCode: string
  Maximum Length: 30

  Default Value: DRAFT

  Abbreviation that identifies the status of the model. A list of accepted values is defined in the lookup type POQ_QUAL_MODEL_STATUS. Review the values for this attribute using the Setup and Maintenance work area and the Manage Standard Lookups task.
• SubjectCode: string
  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.

{
    "required":[
        "ProcurementBUId",
        "QualModel"
    ],
    "type":"object",
    "properties":{
        "ActivationDate":{
            "type":"string",
            "description":"Date and time when the model is activated.",
            "format":"date-time",
            "nullable":true
        },
        "AssessmentOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AutoEvaluateAssessmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment created based on the qualification model will be automatically evaluated. If false, automatic evaluation is disabled. The default value is false.",
            "nullable":true,
            "default":false
        },
        "DefaultAssessmtOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the model's default owner becomes the assessment owner. The default value is false.",
            "nullable":true,
            "default":false
        },
        "EnableScoringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, scoring is enabled on the qualification model. If false, scoring isn't enabled. The default value is false.",
            "nullable":true,
            "default":false
        },
        "ExpirationReminderPeriod":{
            "type":"integer",
            "description":"Period during which the application alerts the owner about the expiration of an assessment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "ExpirationReminderTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of time to indicate days, weeks, or months.",
            "nullable":true
        },
        "GlobalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the setup object is globally accessible by all procurement business units. If false, the setup object isn't globally accessible. The default value is false.",
            "nullable":false,
            "default":false
        },
        "LatestRevisionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the qualification area revision is the most recent. If false, the revision of the question isn't the latest. The default value is false.",
            "nullable":true,
            "default":true
        },
        "NoteToSupplier":{
            "maxLength":1000,
            "type":"string",
            "description":"Value indicating a note to the supplier about the assessment.",
            "nullable":true
        },
        "OriginalQualModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualModel":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification model.",
            "nullable":false
        },
        "QualModelDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the qualification model.",
            "nullable":true
        },
        "QualModelLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":false,
            "default":"SUPPLIER"
        },
        "QualModelUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies whether the record is for a qualification model or checklist.",
            "nullable":true
        },
        "ReassessQualificationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment needs to be reassessed upon the creation of a new qualification. The default value is false.",
            "nullable":true,
            "default":false
        },
        "Revision":{
            "type":"integer",
            "description":"Number that identifies the revision of this model. Revision 0 is the base revision.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            }
        },
        "ShareEligibilityFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":true,
            "default":false
        },
        "ShowAssessmentQualFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment's qualifications are shared with the supplier along with the assessment details. The default value is false.",
            "nullable":true,
            "default":false
        },
        "ShowAssessmtToSuppFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the response summary is shared with the corresponding supplier. If false, it's not shared. The default value is false.",
            "nullable":true,
            "default":false
        },
        "SourcingEligibilityFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":true,
            "default":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the model. A list of accepted values is defined in the lookup type POQ_QUAL_MODEL_STATUS. Review the values for this attribute using the Setup and Maintenance work area and the Manage Standard Lookups task.",
            "nullable":false,
            "default":"DRAFT"
        },
        "SubjectCode":{
            "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
        },
        "areas":{
            "title":"Qualification Model Areas",
            "type":"array",
            "description":"A grouping of areas associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-areas-item-post-request"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-attachments-item-post-request"
            }
        },
        "businessUnits":{
            "title":"Qualification Model Business Units",
            "type":"array",
            "description":"A set of business units associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-businessUnits-item-post-request"
            }
        },
        "outcomes":{
            "title":"Qualification Model Outcomes",
            "type":"array",
            "description":"A set of outcomes associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-outcomes-item-post-request"
            }
        }
    }
}

Nested Schema : Qualification Model Areas

Type: array

Title: Qualification Model Areas

A grouping of areas associated with a particular qualification model.

Show Source

• Array of: object schema

{
    "title":"Qualification Model Areas",
    "type":"array",
    "description":"A grouping of areas associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-areas-item-post-request"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object schema

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

Nested Schema : Qualification Model Business Units

Type: array

Title: Qualification Model Business Units

A set of business units associated with a particular qualification model.

Show Source

• Array of: object schema

{
    "title":"Qualification Model Business Units",
    "type":"array",
    "description":"A set of business units associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-businessUnits-item-post-request"
    }
}

Nested Schema : Qualification Model Outcomes

Type: array

Title: Qualification Model Outcomes

A set of outcomes associated with a particular qualification model.

Show Source

• Array of: object schema

{
    "title":"Qualification Model Outcomes",
    "type":"array",
    "description":"A set of outcomes associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-outcomes-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DisplaySequence: integer (int32)
  Specifies the order in which outcomes display for the qualification model.
• KnockoutScore: integer (int32)
  Specifies the knockout score when scoring is enabled for a qualification area.
• QualAreaId: integer (int64)
  Unique identifier of a qualification area.
• QualAreaName: string
  Title: Qualification Area

  Maximum Length: 80

  Name of the qualification area for a model.
• QualModelAreaId: integer (int64)
  Unique identifier of a qualification model area.
• QualModelId: integer (int64)
  Unique identifier of the model.
• Weight: number
  Specifies the weight when scoring is enabled for a qualification area.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "type":"integer",
            "description":"Specifies the order in which outcomes display for the qualification model.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "KnockoutScore":{
            "type":"integer",
            "description":"Specifies the knockout score when scoring is enabled for a qualification area.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "QualAreaId":{
            "type":"integer",
            "description":"Unique identifier of a qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "QualAreaName":{
            "title":"Qualification Area",
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification area for a model.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "QualModelAreaId":{
            "type":"integer",
            "description":"Unique identifier of a qualification model area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "QualModelId":{
            "type":"integer",
            "description":"Unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Weight":{
            "type":"number",
            "description":"Specifies the weight when scoring is enabled for a qualification area.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AssessmentOwnerId: integer (int64)
  Unique identifier of the user who owns the assessments created using the qualification model.
• ProcurementBUId: integer (int64)
  Unique identifier of a procurement business unit.
• QualModelBUAccessId: integer (int64)
  Unique identifier of the qualification model business unit access.
• QualModelId: integer (int64)
  Unique identifier of the model.

{
    "type":"object",
    "properties":{
        "AssessmentOwnerId":{
            "type":"integer",
            "description":"Unique identifier of the user who owns the assessments created using the qualification model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of a procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualModelBUAccessId":{
            "type":"integer",
            "description":"Unique identifier of the qualification model business unit access.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "QualModelId":{
            "type":"integer",
            "description":"Unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DisplaySequence: integer (int32)
  Order in which the outcomes are displayed to the user for this specific area.
• FromScore: number
  Lowest score for the assessment outcome.
• KnockoutOutcomeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the outcome is assigned to the assessment if the qualification is assigned a knockout score. If false, the outcome isn't assigned. The default value is false.
• NotificationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, a notification of the outcome will be sent for the automatically evaluated assessment. If false, no notification will be sent to the assessment owner. The default value is false.
• OutcomeName: string
  Maximum Length: 80

  Name of the assessment area outcome. This value is set as an outcome of an assessment as part of the evaluation.
• QualModelId: integer (int64)
  Value that uniquely identifies the model.
• QualModelOutcomeId: integer (int64)
  Value that uniquely identifies the outcome of the qualification model.
• SourcingEligibilityCode: string
  Maximum Length: 30

  Value that uniquely identifies the supplier eligibility outcome.
• ToScore: number
  Highest score for the assessment outcome.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "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
            }
        },
        "FromScore":{
            "type":"number",
            "description":"Lowest score for the assessment outcome.",
            "nullable":true
        },
        "KnockoutOutcomeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the outcome is assigned to the assessment if the qualification is assigned a knockout score. If false, the outcome isn't assigned. The default value is false.",
            "nullable":true
        },
        "NotificationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, a notification of the outcome will be sent for the automatically evaluated assessment. If false, no notification will be sent to the assessment owner. The default value is false.",
            "nullable":true
        },
        "OutcomeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the assessment area outcome. This value is set as an outcome of an assessment as part of the evaluation.",
            "nullable":false
        },
        "QualModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualModelOutcomeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the outcome of the qualification model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SourcingEligibilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the supplier eligibility outcome.",
            "nullable":true
        },
        "ToScore":{
            "type":"number",
            "description":"Highest score for the assessment outcome.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• ActivationDate: string (date-time)
  Date and time when the model is activated.
• areas: array Qualification Model Areas
  Title: Qualification Model Areas

  A grouping of areas associated with a particular qualification model.
• AssessmentOwnerId: integer (int64)
  Value that uniquely identifies the owner of the model.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• AutoEvaluateAssessmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment created based on the qualification model will be automatically evaluated. If false, automatic evaluation is disabled. The default value is false.
• businessUnits: array Qualification Model Business Units
  Title: Qualification Model Business Units

  A set of business units associated with a particular qualification model.
• DefaultAssessmtOwnerFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the model's default owner becomes the assessment owner. The default value is false.
• EnableScoringFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, scoring is enabled on the qualification model. If false, scoring isn't enabled. The default value is false.
• ExpirationReminderPeriod: integer (int32)
  Period during which the application alerts the owner about the expiration of an assessment.
• ExpirationReminderType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Unit of time to indicate days, weeks, or months.
• ExpirationReminderTypeCode: string
  Maximum Length: 30

  Unit of time to indicate days, weeks, or months.
• GlobalFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the setup object is globally accessible by all procurement business units. If false, the setup object isn't globally accessible. The default value is false.
• HasInactiveQualAreasFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, the qualification model contains an inactive qualification area.
• HasInactiveQuestionsFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, the qualification model contains a qualification area with an inactive question.
• LatestRevisionFlag: boolean
  Maximum Length: 1

  Default Value: true

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

  The link relations associated with the resource instance.
• NoteToSupplier: string
  Maximum Length: 1000

  Value indicating a note to the supplier about the assessment.
• OriginalQualModelId: integer (int64)
  Value that uniquely identifies the original model.
• outcomes: array Qualification Model Outcomes
  Title: Qualification Model Outcomes

  A set of outcomes associated with a particular qualification model.
• Owner: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person who owns the qualification model.
• OwnerId: integer (int64)
  Value that uniquely identifies the owner of the model.
• ProcurementBU: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the owner of the model.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the owning procurement business unit.
• QualModel: string
  Maximum Length: 80

  Name of the qualification model.
• QualModelDescription: string
  Maximum Length: 240

  Description of the qualification model.
• QualModelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the model.
• QualModelLevel: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• QualModelLevelCode: string
  Maximum Length: 30

  Default Value: SUPPLIER

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• QualModelUsageCode: string
  Maximum Length: 30

  Value that uniquely identifies whether the record is for a qualification model or checklist.
• ReassessQualificationFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment needs to be reassessed upon the creation of a new qualification. The default value is false.
• Revision: integer (int32)
  Default Value: 0

  Number that identifies the revision of this model. Revision 0 is the base revision.
• ShareEligibilityFlag: boolean
  Maximum Length: 1

  Default Value: false

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• ShowAssessmentQualFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the assessment's qualifications are shared with the supplier along with the assessment details. The default value is false.
• ShowAssessmtToSuppFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, the response summary is shared with the corresponding supplier. If false, it's not shared. The default value is false.
• SourcingEligibilityFlag: boolean
  Maximum Length: 1

  Default Value: false

  Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the model.
• StatusCode: string
  Maximum Length: 30

  Default Value: DRAFT

  Abbreviation that identifies the status of the model. A list of accepted values is defined in the lookup type POQ_QUAL_MODEL_STATUS. Review the values for this attribute using the Setup and Maintenance work area and the Manage Standard Lookups task.
• Subject: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that identifies the subject to be associated with the area that's used to conduct a search.
• SubjectCode: string
  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":{
        "ActivationDate":{
            "type":"string",
            "description":"Date and time when the model is activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AutoEvaluateAssessmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment created based on the qualification model will be automatically evaluated. If false, automatic evaluation is disabled. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DefaultAssessmtOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the model's default owner becomes the assessment owner. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnableScoringFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, scoring is enabled on the qualification model. If false, scoring isn't enabled. 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 an assessment.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ExpirationReminderType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Unit of time to indicate days, weeks, or months.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationReminderTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unit of time to indicate days, weeks, or months.",
            "nullable":true,
            "x-queryable":true
        },
        "GlobalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the setup object is globally accessible by all procurement business units. If false, the setup object isn't globally accessible. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "HasInactiveQualAreasFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the qualification model contains an inactive qualification area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasInactiveQuestionsFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the qualification model contains a qualification area with an inactive question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestRevisionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the qualification area revision is the most recent. If false, the revision of the question isn't the latest. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "NoteToSupplier":{
            "maxLength":1000,
            "type":"string",
            "description":"Value indicating a note to the supplier about the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalQualModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who owns the qualification model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the owner of the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owning procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualModel":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification model.",
            "nullable":false,
            "x-queryable":true
        },
        "QualModelDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the qualification model.",
            "nullable":true,
            "x-queryable":true
        },
        "QualModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the model.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualModelLevel":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualModelLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":false,
            "default":"SUPPLIER",
            "x-queryable":true
        },
        "QualModelUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies whether the record is for a qualification model or checklist.",
            "nullable":true,
            "x-queryable":true
        },
        "ReassessQualificationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment needs to be reassessed upon the creation of a new qualification. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Revision":{
            "type":"integer",
            "description":"Number that identifies the revision of this model. Revision 0 is the base revision.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ShareEligibilityFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ShowAssessmentQualFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the assessment's qualifications are shared with the supplier along with the assessment details. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ShowAssessmtToSuppFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the response summary is shared with the corresponding supplier. If false, it's not shared. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SourcingEligibilityFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Models in supplier qualification management, along with the underlying qualifications. You must have the necessary roles and privileges to use this REST resource. For additional details, refer to the Job Roles and Privileges and Status Codes topics.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the model. A list of accepted values is defined in the lookup type POQ_QUAL_MODEL_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
        },
        "Subject":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the subject to be associated with the area that's used to conduct a search.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectCode":{
            "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
        },
        "areas":{
            "title":"Qualification Model Areas",
            "type":"array",
            "description":"A grouping of areas associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-areas-item-response"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-attachments-item-response"
            }
        },
        "businessUnits":{
            "title":"Qualification Model Business Units",
            "type":"array",
            "description":"A set of business units associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-businessUnits-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "outcomes":{
            "title":"Qualification Model Outcomes",
            "type":"array",
            "description":"A set of outcomes associated with a particular qualification model.",
            "items":{
                "$ref":"#/components/schemas/supplierQualificationModels-outcomes-item-response"
            }
        }
    }
}

Nested Schema : Qualification Model Areas

Type: array

Title: Qualification Model Areas

A grouping of areas associated with a particular qualification model.

Show Source

• Array of: object supplierQualificationModels-areas-item-response

{
    "title":"Qualification Model Areas",
    "type":"array",
    "description":"A grouping of areas associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-areas-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : Qualification Model Business Units

Type: array

Title: Qualification Model Business Units

A set of business units associated with a particular qualification model.

Show Source

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

{
    "title":"Qualification Model Business Units",
    "type":"array",
    "description":"A set of business units associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-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 : Qualification Model Outcomes

Type: array

Title: Qualification Model Outcomes

A set of outcomes associated with a particular qualification model.

Show Source

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

{
    "title":"Qualification Model Outcomes",
    "type":"array",
    "description":"A set of outcomes associated with a particular qualification model.",
    "items":{
        "$ref":"#/components/schemas/supplierQualificationModels-outcomes-item-response"
    }
}

Nested Schema : supplierQualificationModels-areas-item-response

Type: object

Show Source

• DisplaySequence: integer (int32)
  Specifies the order in which outcomes display for the qualification model.
• KnockoutScore: integer (int32)
  Specifies the knockout score when scoring is enabled for a qualification area.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QualAreaId: integer (int64)
  Unique identifier of a qualification area.
• QualAreaName: string
  Title: Qualification Area

  Maximum Length: 80

  Name of the qualification area for a model.
• QualModelAreaId: integer (int64)
  Unique identifier of a qualification model area.
• QualModelId: integer (int64)
  Unique identifier of the model.
• Weight: number
  Specifies the weight when scoring is enabled for a qualification area.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "type":"integer",
            "description":"Specifies the order in which outcomes display for the qualification model.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "KnockoutScore":{
            "type":"integer",
            "description":"Specifies the knockout score when scoring is enabled for a qualification area.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QualAreaId":{
            "type":"integer",
            "description":"Unique identifier of a qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QualAreaName":{
            "title":"Qualification Area",
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification area for a model.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QualModelAreaId":{
            "type":"integer",
            "description":"Unique identifier of a qualification model area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualModelId":{
            "type":"integer",
            "description":"Unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Weight":{
            "type":"number",
            "description":"Specifies the weight when scoring is enabled for a qualification area.",
            "nullable":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 : 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 : supplierQualificationModels-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated 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

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

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of 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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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 : supplierQualificationModels-businessUnits-item-response

Type: object

Show Source

• AssessmentOwnerId: integer (int64)
  Unique identifier of the user who owns the assessments created using the qualification model.
• AssessmentOwnerName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the user who owns the assessments created using the qualification model.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.
• ProcurementBUId: integer (int64)
  Unique identifier of a procurement business unit.
• QualModelBUAccessId: integer (int64)
  Unique identifier of the qualification model business unit access.
• QualModelId: integer (int64)
  Unique identifier of the model.

{
    "type":"object",
    "properties":{
        "AssessmentOwnerId":{
            "type":"integer",
            "description":"Unique identifier of the user who owns the assessments created using the qualification model.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssessmentOwnerName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the user who owns the assessments created using the qualification model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of a procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualModelBUAccessId":{
            "type":"integer",
            "description":"Unique identifier of the qualification model business unit access.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualModelId":{
            "type":"integer",
            "description":"Unique identifier of the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : supplierQualificationModels-outcomes-item-response

Type: object

Show Source

• DisplaySequence: integer (int32)
  Order in which the outcomes are displayed to the user for this specific area.
• FromScore: number
  Lowest score for the assessment outcome.
• KnockoutOutcomeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the outcome is assigned to the assessment if the qualification is assigned a knockout score. If false, the outcome isn't assigned. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, a notification of the outcome will be sent for the automatically evaluated assessment. If false, no notification will be sent to the assessment owner. The default value is false.
• OutcomeName: string
  Maximum Length: 80

  Name of the assessment area outcome. This value is set as an outcome of an assessment as part of the evaluation.
• QualModelId: integer (int64)
  Value that uniquely identifies the model.
• QualModelOutcomeId: integer (int64)
  Value that uniquely identifies the outcome of the qualification model.
• SourcingEligibilityCode: string
  Maximum Length: 30

  Value that uniquely identifies the supplier eligibility outcome.
• ToScore: number
  Highest score for the assessment outcome.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "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
        },
        "FromScore":{
            "type":"number",
            "description":"Lowest score for the assessment outcome.",
            "nullable":true,
            "x-queryable":true
        },
        "KnockoutOutcomeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the outcome is assigned to the assessment if the qualification is assigned a knockout score. If false, the outcome isn't assigned. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, a notification of the outcome will be sent for the automatically evaluated assessment. If false, no notification will be sent to the assessment owner. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the assessment area outcome. This value is set as an outcome of an assessment as part of the evaluation.",
            "nullable":false,
            "x-queryable":true
        },
        "QualModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualModelOutcomeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the outcome of the qualification model.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourcingEligibilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the supplier eligibility outcome.",
            "nullable":true,
            "x-queryable":true
        },
        "ToScore":{
            "type":"number",
            "description":"Highest score for the assessment outcome.",
            "nullable":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"
    }
}

Links

areas

Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationModels/{supplierQualificationModelsUniqID}/child/areas

Parameters:

• supplierQualificationModelsUniqID: $request.path.supplierQualificationModelsUniqID

A grouping of areas associated with a particular qualification model.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationModels/{supplierQualificationModelsUniqID}/child/attachments

Parameters:

• supplierQualificationModelsUniqID: $request.path.supplierQualificationModelsUniqID

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

businessUnits

Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationModels/{supplierQualificationModelsUniqID}/child/businessUnits

Parameters:

• supplierQualificationModelsUniqID: $request.path.supplierQualificationModelsUniqID

A set of business units associated with a particular qualification model.

outcomes

Operation: /fscmRestApi/resources/11.13.18.05/supplierQualificationModels/{supplierQualificationModelsUniqID}/child/outcomes

Parameters:

• supplierQualificationModelsUniqID: $request.path.supplierQualificationModelsUniqID

A set of outcomes associated with a particular qualification model.

Back to Top

Examples

This example describes how to create one qualification model.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierQualificationModels"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierQualificationModels"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
  "QualModel": "Supplier Sustainability Assessment",
  "QualModelDescription": "Evaluates supplier sustainability, environmental, and governance capabilities.",
  "OwnerId": 100010026863791,
  "ProcurementBUId": 204,
  "GlobalFlag": false,
  "AssessmentOwnerId": 100010026863791,
  "EnableScoringFlag": true,
  "AutoEvaluateAssessmentFlag": false,
  "DefaultAssessmtOwnerFlag": true,
  "ExpirationReminderPeriod": 30,
  "ExpirationReminderTypeCode": "DAYS",
  "ReassessQualificationFlag": true,
  "ShowAssessmtToSuppFlag": true,
  "ShowAssessmentQualFlag": true,
  "SourcingEligibilityFlag": true,
  "ShareEligibilityFlag": true,
  "NoteToSupplier": "The assessment summary is shared after evaluation."
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "QualModelId": 300100250000001,
  "ActivationDate": null,
  "AssessmentOwnerId": 100010026863791,
  "AutoEvaluateAssessmentFlag": false,
  "DefaultAssessmtOwnerFlag": true,
  "EnableScoringFlag": true,
  "ExpirationReminderPeriod": 30,
  "ExpirationReminderTypeCode": "DAYS",
  "GlobalFlag": false,
  "LatestRevisionFlag": true,
  "NoteToSupplier": "The assessment summary is shared after evaluation.",
  "OriginalQualModelId": 300100250000001,
  "OwnerId": 100010026863791,
  "ProcurementBUId": 204,
  "QualModelDescription": "Evaluates supplier sustainability, environmental, and governance capabilities.",
  "QualModelLevelCode": "SUPPLIER",
  "SubjectCode": "SUSTAINABILITY",
  "QualModel": "Supplier Sustainability Assessment",
  "StatusCode": "DRAFT",
  "QualModelUsageCode": "QUALIFICATION_MODEL",
  "ReassessQualificationFlag": true,
  "Revision": 0,
  "ShowAssessmentQualFlag": true,
  "ShowAssessmtToSuppFlag": true,
  "Status": "Draft",
  "Subject": "Sustainability",
  "Owner": "Davis, Cody",
  "ExpirationReminderType": "Days",
  "ProcurementBU": "Vision Operations",
  "SourcingEligibilityFlag": true,
  "ShareEligibilityFlag": true,
  "QualModelLevel": "Supplier",
  "HasInactiveQualAreasFlag": false,
  "HasInactiveQuestionsFlag": false,
  "StandardsOrganizationCode": null,
  "StandardsOrganization": null,
  "AssessmentOwner": "Davis, Cody",
  "CreatedBy": "REST.USER",
  "CreationDate": "2026-08-25T10:30:00+00:00",
  "LastUpdatedBy": "REST.USER",
  "LastUpdateDate": "2026-08-25T10:30:00+00:00",
  "links": [
    {"rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001", "name": "supplierQualificationModels", "kind": "item"},
    {"rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001", "name": "supplierQualificationModels", "kind": "item"},
    {"rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001/child/areas", "name": "areas", "kind": "collection"},
    {"rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001/child/attachments", "name": "attachments", "kind": "collection"},
    {"rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001/child/businessUnits", "name": "businessUnits", "kind": "collection"},
    {"rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001/child/outcomes", "name": "outcomes", "kind": "collection"},
    {"rel": "action", "href": "https://servername/fscmRestApi/resources/11.13.18.05/supplierQualificationModels/300100250000001/action/activate", "name": "activate", "kind": "other"}
  ]
}

Back to Top