Jump to

• Request
• Response

Update one qualification area

patch

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

Request

Path Parameters

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EvaluationDueDate: string (date)
  Title: Qualification Evaluation Due Date

  Date when the qualification was due for evaluation.
• Owner: string
  Title: Owner

  Maximum Length: 240

  Name of the qualification area owner.
• OwnerId: integer (int64)
  Value that uniquely identifies the name of the qualification area owner.

{
    "type":"object",
    "properties":{
        "EvaluationDueDate":{
            "title":"Qualification Evaluation Due Date",
            "type":"string",
            "description":"Date when the qualification was due for evaluation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Owner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Name of the qualification area owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the name of the qualification area owner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

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 : supplierInitiatives-qualificationAreas-item-response

Type: object

Show Source

• DisplaySequence: integer (int32)
  Title: Display Sequence

  Display sequence of the qualification area added to a qualification kind of initiative.
• EvaluationDueDate: string (date)
  Title: Qualification Evaluation Due Date

  Date when the qualification was due for evaluation.
• HasInactiveQuestionFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates that there is an inactive question in the initiative's qualification area.
• InformationOnlyFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then a qualification based on this qualification area will be evaluated or will be used for information only purposes. If false, then the qualification won't be used for information only process. The default value is false.
• InitiativeQualificationAreaId: integer (int64)
  Value that uniquely identifies the qualification area.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalQualificationAreaId: integer (int64)
  Value that uniquely identifies the original qualification area.
• Owner: string
  Title: Owner

  Maximum Length: 240

  Name of the qualification area owner.
• OwnerId: integer (int64)
  Value that uniquely identifies the name of the qualification area owner.
• OwnerName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the name of the qualification area owner.
• QualAreaLevel: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that identifies whether the area is relevant to a supplier or to a supplier site.
• QualAreaLevelCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies whether the area is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• QualificationArea: string
  Title: Qualification Area

  Maximum Length: 80

  Name of the qualification area entered by the user.
• QualificationAreaDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the qualification area entered by user.
• QualificationAreaId: integer (int64)
  Value that uniquely identifies the qualification area.
• QualificationAreaRevision: integer (int32)
  Title: Revision

  Read Only: true

  Number that identifies the current version of the qualification area definition.
• QualificationAreaStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of the qualification area.
• QualificationAreaStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the qualification area. Accepted values are defined in the lookup type POQ_QUAL_AREA_STATUS. To review the available values, use the Setup and Maintenance work area and the Manage Standard Lookups task.
• SyncCheckFlag: boolean
  Title: Synchronization Check

  Maximum Length: 1

  A value that indicates whether the acceptable response to a supplier attribute question is synchronized with the supplier profile. It can be either true or false. If true, the synchronization check has passed for the qualification area. If false, the synchronization check has failed. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the qualification area added to a qualification kind of initiative.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EvaluationDueDate":{
            "title":"Qualification Evaluation Due Date",
            "type":"string",
            "description":"Date when the qualification was due for evaluation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "HasInactiveQuestionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that there is an inactive question in the initiative's qualification area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InformationOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a qualification based on this qualification area will be evaluated or will be used for information only purposes. If false, then the qualification won't be used for information only process. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiativeQualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OriginalQualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original qualification area.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Owner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Name of the qualification area owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the name of the qualification area owner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "OwnerName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the name of the qualification area owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualAreaLevel":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies whether the area is relevant to a supplier or to a supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualAreaLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies whether the area is relevant to a supplier or to a supplier site. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_LEVEL. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationArea":{
            "title":"Qualification Area",
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification area entered by the user.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "QualificationAreaDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the qualification area entered by user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "QualificationAreaRevision":{
            "title":"Revision",
            "type":"integer",
            "description":"Number that identifies the current version of the qualification area definition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "QualificationAreaStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the qualification area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationAreaStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the qualification area. Accepted values are defined in the lookup type POQ_QUAL_AREA_STATUS. To review the available values, use the Setup and Maintenance work area and the Manage Standard Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SyncCheckFlag":{
            "title":"Synchronization Check",
            "maxLength":1,
            "type":"boolean",
            "description":"A value that indicates whether the acceptable response to a supplier attribute question is synchronized with the supplier profile. It can be either true or false. If true, the synchronization check has passed for the qualification area. If false, the synchronization check has failed. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "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."
        }
    }
}

Back to Top