Jump to

• Request
• Response

Update one qualification

patch

/fscmRestApi/resources/11.13.18.05/supplierAssessments/{supplierAssessmentsUniqID}/child/qualifications/{qualificationsUniqID}

Request

Path Parameters

• qualificationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Qualifications resource and used to uniquely identify an instance of Supplier Qualifications. The client should not generate the hash key value. Instead, the client should query on the Supplier Qualifications collection resource in order to navigate to a specific instance of Supplier Qualifications to get the hash key.
• supplierAssessmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Assessments resource and used to uniquely identify an instance of Supplier Assessments. The client should not generate the hash key value. Instead, the client should query on the Supplier Assessments collection resource in order to navigate to a specific instance of Supplier Assessments to get the hash key.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EvaluationNote: string
  Title: Evaluation Note

  Maximum Length: 1000

  Indicates the note added by the evaluation team member for each qualification in the assessment.
• QualificationId: integer (int64)
  Value that uniquely identifies the qualification.
• ReusedFlag: boolean
  Maximum Length: 1

  Indicates the note to supplier.

{
    "type":"object",
    "properties":{
        "EvaluationNote":{
            "title":"Evaluation Note",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the note added by the evaluation team member for each qualification in the assessment.",
            "nullable":true,
            "x-queryable":false
        },
        "QualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReusedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the note to supplier.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : supplierAssessments-qualifications-item-response

Type: object

Show Source

• AssessmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the assessment.
• AssessmentQualId: integer (int64)
  Read Only: true

  Value that uniquely identifies the assessment qualification.
• EffectiveEndDate: string (date-time)
  Title: End Date

  Read Only: true

  Indicates the end date of the supplier qualification.
• EffectiveStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Indicates the start date of the supplier qualification.
• EvaluationNote: string
  Title: Evaluation Note

  Maximum Length: 1000

  Indicates the note added by the evaluation team member for each qualification in the assessment.
• IsQualificationForReplaceFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, the qualification can be replaced on the assessment. If false, the qualification can't be replaced.There is no default value for this attribute.
• KnockoutScore: integer
  Title: Knockout Score

  Read Only: true

  Value indicating that a qualification score same as or less than the knockout score will give the supplier assessment the knockout outcome.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the owner of the qualification.
• QualificationAreaId: integer (int64)
  Read Only: true

  Value that uniquely identifies the qualification area used to create the qualification.
• QualificationId: integer (int64)
  Value that uniquely identifies the qualification.
• QualificationName: string
  Title: Qualification Name

  Read Only: true

  Maximum Length: 80

  Name of the qualification.
• QualificationNumber: string
  Title: Qualification

  Read Only: true

  Maximum Length: 30

  Indicates the number assigned to the qualification.
• QualificationOutcome: string
  Title: Qualification Outcome

  Read Only: true

  Maximum Length: 80

  Indicates the outcome assigned to the qualification.
• QualificationOwner: string
  Title: Owner

  Read Only: true

  Maximum Length: 240

  Name of the owner of the qualification.
• QualificationProcurementBU: string
  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.
• QualificationProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit.
• QualificationScore: number
  Title: Score

  Read Only: true

  Indicates the calculated score for the qualification.
• QualificationSupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• QualificationSupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.
• ReusedFlag: boolean
  Maximum Length: 1

  Indicates the note to supplier.
• RevisionNumber: integer (int32)
  Title: Revision

  Read Only: true

  Default Value: 0

  Revision number of this qualification area used to create the qualification.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the qualification.
• StatusCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the status of the qualification. A list of accepted values is defined in the lookup POQ_QUALIFICATION_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• Weight: number
  Title: Weight

  Read Only: true

  Value that indicates the importance of the qualification in the supplier assessment. This value is used to calculate the overall score of the assessment.
• WeightedScore: number
  Title: Weighted Score

  Read Only: true

  Indicates the weighted score calculated for the qualification in the supplier assessment.

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assessment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssessmentQualId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assessment qualification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Indicates the end date of the supplier qualification.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Indicates the start date of the supplier qualification.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EvaluationNote":{
            "title":"Evaluation Note",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the note added by the evaluation team member for each qualification in the assessment.",
            "nullable":true,
            "x-queryable":false
        },
        "IsQualificationForReplaceFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the qualification can be replaced on the assessment. If false, the qualification can't be replaced.There is no default value for this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnockoutScore":{
            "title":"Knockout Score",
            "type":"integer",
            "description":"Value indicating that a qualification score same as or less than the knockout score will give the supplier assessment the knockout outcome.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the owner of the qualification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area used to create the qualification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualificationName":{
            "title":"Qualification Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationNumber":{
            "title":"Qualification",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the number assigned to the qualification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationOutcome":{
            "title":"Qualification Outcome",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the outcome assigned to the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationOwner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Name of the owner of the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationProcurementBU":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualificationScore":{
            "title":"Score",
            "type":"number",
            "description":"Indicates the calculated score for the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualificationSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReusedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the note to supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "RevisionNumber":{
            "title":"Revision",
            "type":"integer",
            "description":"Revision number of this qualification area used to create the qualification.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the qualification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the status of the qualification. A list of accepted values is defined in the lookup POQ_QUALIFICATION_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"number",
            "description":"Value that indicates the importance of the qualification in the supplier assessment. This value is used to calculate the overall score of the assessment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WeightedScore":{
            "title":"Weighted Score",
            "type":"number",
            "description":"Indicates the weighted score calculated for the qualification in the supplier assessment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

createNewQualification

Operation: /fscmRestApi/resources/11.13.18.05/supplierAssessments/{supplierAssessmentsUniqID}/child/qualifications/{qualificationsUniqID}/action/createNewQualification

Parameters:

• qualificationsUniqID: $request.path.qualificationsUniqID
• supplierAssessmentsUniqID: $request.path.supplierAssessmentsUniqID

Creates a new qualification by revising an existing supplier qualification as part of the supplier assessment.

replaceQualification

Operation: /fscmRestApi/resources/11.13.18.05/supplierAssessments/{supplierAssessmentsUniqID}/child/qualifications/{qualificationsUniqID}/action/replaceQualification

Parameters:

• qualificationsUniqID: $request.path.qualificationsUniqID
• supplierAssessmentsUniqID: $request.path.supplierAssessmentsUniqID

Replaces a supplier qualification with another qualification in the supplier assessment.

Back to Top