Jump to

• Request
• Response

Update one supplier

patch

/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{supplierInitiativesUniqID}/child/suppliers/{suppliersUniqID}

Request

Path Parameters

• supplierInitiativesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Initiatives resource and used to uniquely identify an instance of Supplier Initiatives. The client should not generate the hash key value. Instead, the client should query on the Supplier Initiatives collection resource in order to navigate to a specific instance of Supplier Initiatives to get the hash key.
• suppliersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Suppliers resource and used to uniquely identify an instance of Suppliers. The client should not generate the hash key value. Instead, the client should query on the Suppliers collection resource in order to navigate to a specific instance of Suppliers 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

• InternalResponder: string
  Title: Internal Responder

  Maximum Length: 240

  Name of the internal responder.
• InternalResponderId: integer (int64)
  Value that uniquely identifies the internal responder.
• SendInternalQuestionnaireFlag: boolean
  Title: Send Internal Questionnaire

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then questionnaire is sent to the internal responder. If false, then questionnaire is not sent to the internal responder. The default value is true if the response to any of the required questions in the internal questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.
• SendSupplierQuestionnaireFlag: boolean
  Title: Send Supplier Questionnaire

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then questionnaire is sent to the supplier contact. If false, then questionnaire is not sent to the supplier contact. The default value is true if the response to any of the required questions in the supplier questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.
• SupplierContact: string
  Title: Supplier Contact

  Maximum Length: 255

  Name of the supplier contact.
• SupplierContactId: integer (int64)
  Value that uniquely identifies the supplier contact.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "InternalResponder":{
            "title":"Internal Responder",
            "maxLength":240,
            "type":"string",
            "description":"Name of the internal responder.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InternalResponderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the internal responder.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SendInternalQuestionnaireFlag":{
            "title":"Send Internal Questionnaire",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then questionnaire is sent to the internal responder. If false, then questionnaire is not sent to the internal responder. The default value is true if the response to any of the required questions in the internal questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CalculateQnrFlags"
                ]
            }
        },
        "SendSupplierQuestionnaireFlag":{
            "title":"Send Supplier Questionnaire",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then questionnaire is sent to the supplier contact. If false, then questionnaire is not sent to the supplier contact. The default value is true if the response to any of the required questions in the supplier questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CalculateQnrFlags"
                ]
            }
        },
        "SupplierContact":{
            "title":"Supplier Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "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-suppliers-item-response

Type: object

Show Source

• InitiativeSupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• InternalResponder: string
  Title: Internal Responder

  Maximum Length: 240

  Name of the internal responder.
• InternalResponderId: integer (int64)
  Value that uniquely identifies the internal responder.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponsePulledFlag: boolean
  Title: Response Pulled

  Maximum Length: 1

  Value that indicates whether the response has been pulled for this supplier as part of initiative or not. Contains one of the following values: true or false. If true, then data is pulled from the profile into repository. If false, then data is not pulled from the profile into repository. This attribute does not have a default value.
• SendInternalQuestionnaireFlag: boolean
  Title: Send Internal Questionnaire

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then questionnaire is sent to the internal responder. If false, then questionnaire is not sent to the internal responder. The default value is true if the response to any of the required questions in the internal questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.
• SendSupplierQuestionnaireFlag: boolean
  Title: Send Supplier Questionnaire

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then questionnaire is sent to the supplier contact. If false, then questionnaire is not sent to the supplier contact. The default value is true if the response to any of the required questions in the supplier questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.
• Supplier: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier.
• SupplierContact: string
  Title: Supplier Contact

  Maximum Length: 255

  Name of the supplier contact.
• SupplierContactId: integer (int64)
  Value that uniquely identifies the supplier contact.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Title: Supplier Number

  Maximum Length: 30

  Number that identifies the supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "InitiativeSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InternalResponder":{
            "title":"Internal Responder",
            "maxLength":240,
            "type":"string",
            "description":"Name of the internal responder.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InternalResponderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the internal responder.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ResponsePulledFlag":{
            "title":"Response Pulled",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the response has been pulled for this supplier as part of initiative or not. Contains one of the following values: true or false. If true, then data is pulled from the profile into repository. If false, then data is not pulled from the profile into repository. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "SendInternalQuestionnaireFlag":{
            "title":"Send Internal Questionnaire",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then questionnaire is sent to the internal responder. If false, then questionnaire is not sent to the internal responder. The default value is true if the response to any of the required questions in the internal questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CalculateQnrFlags"
                ]
            }
        },
        "SendSupplierQuestionnaireFlag":{
            "title":"Send Supplier Questionnaire",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then questionnaire is sent to the supplier contact. If false, then questionnaire is not sent to the supplier contact. The default value is true if the response to any of the required questions in the supplier questionnaire is missing in the response repository. Else, the default value is false. This attribute is used for both qualification and assessment type of initiatives.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CalculateQnrFlags"
                ]
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierContact":{
            "title":"Supplier Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":false,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "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