Jump to

• Request
• Response

Update one questionnaire translation

patch

/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{supplierInitiativesUniqID}/child/questionnaires/{QuestnaireId}/child/questionnaireTranslations/{questionnaireTranslationsUniqID}

Request

Path Parameters

• QuestnaireId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• questionnaireTranslationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- QuestnaireId and Language ---for the Questionnaire Translations resource and used to uniquely identify an instance of Questionnaire Translations. The client should not generate the hash key value. Instead, the client should query on the Questionnaire Translations collection resource with a filter on the primary key values in order to navigate to a specific instance of Questionnaire Translations.
  
  For example: questionnaireTranslations?q=QuestnaireId=<value1>;Language=<value2>
• 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

• 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

• Introduction: string
  Title: Introduction

  Maximum Length: 4000

  A brief introduction to the questionnaire.
• QuestnaireTitle: string
  Title: Title

  Maximum Length: 80

  Title of the questionnaire.

{
    "type":"object",
    "properties":{
        "Introduction":{
            "title":"Introduction",
            "maxLength":4000,
            "type":"string",
            "description":"A brief introduction to the questionnaire.",
            "nullable":true
        },
        "QuestnaireTitle":{
            "title":"Title",
            "maxLength":80,
            "type":"string",
            "description":"Title of the questionnaire.",
            "nullable":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 : supplierInitiatives-questionnaires-questionnaireTranslations-item-response

Type: object

Show Source

• Introduction: string
  Title: Introduction

  Maximum Length: 4000

  A brief introduction to the questionnaire.
• Language: string
  Read Only: true

  Maximum Length: 4

  Language code for the record.
• LanguageName: string
  Title: Language

  Read Only: true

  Maximum Length: 255

  Indicates the language in which the record is written.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Indicates the date and time when the record was last modified.
• LastUpdatedByName: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last modified the record.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the questionnaire.
• QuestnaireTitle: string
  Title: Title

  Maximum Length: 80

  Title of the questionnaire.
• SourceLang: string
  Read Only: true

  Maximum Length: 4

  Indicates the code of the language in which the record was created.
• SourceLangName: string
  Title: Source Language

  Read Only: true

  Maximum Length: 255

  The language in which the record was created.

{
    "type":"object",
    "properties":{
        "Introduction":{
            "title":"Introduction",
            "maxLength":4000,
            "type":"string",
            "description":"A brief introduction to the questionnaire.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language code for the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LanguageName":{
            "title":"Language",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the language in which the record is written.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time when the record was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last modified the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestnaireId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestnaireTitle":{
            "title":"Title",
            "maxLength":80,
            "type":"string",
            "description":"Title of the questionnaire.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language in which the record was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLangName":{
            "title":"Source Language",
            "maxLength":255,
            "type":"string",
            "description":"The language in which the record was created.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top