Jump to

• Request
• Response

Get all questionnaire questions

get

/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{supplierInitiativesUniqID}/child/questionnaires/{QuestnaireId}/child/questionnaireSections/{QuestnaireSectionId}/child/questionnaireQuestions

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=
• QuestnaireSectionId(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=
• 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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey :Find the questionnaire section question according to the question identifier.
    Finder Variables:
    • QuestnaireQuestionId :Value that uniquely identifies the questionnaire question.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowRespCommentFlag; boolean; Indicates whether comments are allowed for the question response.
  • AttachmentAllowed; string; Indicates whether response attachments are required, optional, or not allowed.
  • AttachmentAllowedCode; string; Code for whether the response attachment is allowed.
  • BranchLevel; integer; Indicates the level at which the question appears in the questionnaire.
  • CategoryCode; string; Code for identifying the categorization of the supplier attribute.
  • DisplayNumber; string; The question display number in the questionnaire.
  • DisplayPreferredRespFlag; boolean; Indicates whether there is a preferred response.
  • ParentAccResponseId; integer; Value that uniquely identifies the parent acceptable response on which the question is based.
  • ParentQuestionId; integer; Value that uniquely identifies the parent question of a questionnaire question.
  • ParentQuestnaireQuestId; integer; Value that uniquely identifies the parent questionnaire question.
  • PreferredResponseDate; string; Value of the preferred response in Date format.
  • PreferredResponseDatetime; string; Value of the preferred response in Date and Time format.
  • PreferredResponseNumber; number; Value of the preferred response in Number format.
  • PreferredResponseText; string; Value of the preferred response in Text format.
  • QuestionHint; string; Hint to the question.
  • QuestionId; integer; Value that uniquely identifies the Question.
  • QuestionLevel; string; Indicates whether the question is relevant to a supplier or to a supplier site.
  • QuestionLevelCode; string; Code to specify the question level.
  • QuestionName; string; Name of the questionnaire question.
  • QuestionType; string; Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses.
  • QuestionTypeCode; string; Code to specify the question type.
  • QuestnaireId; integer; Value that uniquely identifies the questionnaire.
  • QuestnaireQuestionId; integer; Value that uniquely identifies a questionnaire question.
  • QuestnaireSectionId; integer; Value that uniquely identifies the questionnaire section.
  • ResponseRequiredFlag; boolean; Indicates whether the response is required for the question.
  • ResponseType; string; Indicates the response type for questions of text entry box type, such as text, number or date.
  • ResponseTypeCode; string; Code to indicate the response type for questions of text entry box type.
  • SupplierAttributeCode; string; Code to uniquely identify the supplier attribute that the question is mapped to.
  • SupplierAttributeFlag; boolean; Indicates whether the question is mapped to an attribute from the supplier profile.
  • SupplierAttributeName; string; Indicates the supplier attribute that the question is mapped to.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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-questionnaireSections-questionnaireQuestions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-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 : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-item-response

Type: object

Show Source

• AllowRespCommentFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether comments are allowed for the question response.
• AttachmentAllowed: string
  Title: Response Attachments

  Read Only: true

  Maximum Length: 80

  Indicates whether response attachments are required, optional, or not allowed.
• AttachmentAllowedCode: string
  Read Only: true

  Maximum Length: 30

  Code for whether the response attachment is allowed.
• BranchLevel: integer (int32)
  Read Only: true

  Indicates the level at which the question appears in the questionnaire.
• CategoryCode: string
  Read Only: true

  Maximum Length: 30

  Code for identifying the categorization of the supplier attribute.
• DisplayNumber: string
  Read Only: true

  Maximum Length: 30

  The question display number in the questionnaire.
• DisplayPreferredRespFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether there is a preferred response.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the parent acceptable response on which the question is based.
• ParentQuestionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent question of a questionnaire question.
• ParentQuestnaireQuestId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent questionnaire question.
• PreferredResponseDate: string (date)
  Title: Preferred Response

  Read Only: true

  Value of the preferred response in Date format.
• PreferredResponseDatetime: string (date-time)
  Title: Preferred Response

  Read Only: true

  Value of the preferred response in Date and Time format.
• PreferredResponseNumber: number
  Title: Preferred Response

  Read Only: true

  Value of the preferred response in Number format.
• PreferredResponseText: string
  Title: Preferred Response

  Read Only: true

  Maximum Length: 4000

  Value of the preferred response in Text format.
• QuestionHint: string
  Title: Hint

  Read Only: true

  Maximum Length: 1000

  Hint to the question.
• QuestionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the Question.
• QuestionLevel: string
  Title: Question Level

  Read Only: true

  Maximum Length: 80

  Indicates whether the question is relevant to a supplier or to a supplier site.
• QuestionLevelCode: string
  Title: Question Level

  Read Only: true

  Maximum Length: 30

  Code to specify the question level.
• questionnaireAcceptableResponses: array Acceptable Responses
  Title: Acceptable Responses

  Initiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.
• questionnaireQuestionAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• QuestionName: string
  Title: Question

  Read Only: true

  Maximum Length: 80

  Name of the questionnaire question.
• QuestionText: string (byte)
  Title: Question Text

  Read Only: true

  Text of the question to be displayed to responders of a questionnaire.
• QuestionType: string
  Title: Question Type

  Read Only: true

  Maximum Length: 80

  Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses.
• QuestionTypeCode: string
  Title: Question Type

  Read Only: true

  Maximum Length: 30

  Code to specify the question type.
• QuestnaireId: integer (int64)
  Read Only: true

  Value that uniquely identifies the questionnaire.
• QuestnaireQuestionId: integer (int64)
  Read Only: true

  Value that uniquely identifies a questionnaire question.
• QuestnaireSectionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the questionnaire section.
• ResponseRequiredFlag: boolean
  Title: Response Required

  Read Only: true

  Maximum Length: 1

  Indicates whether the response is required for the question.
• ResponseType: string
  Title: Response Type

  Read Only: true

  Maximum Length: 80

  Indicates the response type for questions of text entry box type, such as text, number or date.
• ResponseTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code to indicate the response type for questions of text entry box type.
• SupplierAttributeCode: string
  Title: Supplier Attribute

  Read Only: true

  Maximum Length: 35

  Code to uniquely identify the supplier attribute that the question is mapped to.
• SupplierAttributeFlag: boolean
  Title: Mapped to Supplier Attribute

  Read Only: true

  Maximum Length: 1

  Indicates whether the question is mapped to an attribute from the supplier profile.
• SupplierAttributeName: string
  Title: Supplier Site Attribute

  Read Only: true

  Maximum Length: 200

  Indicates the supplier attribute that the question is mapped to.

{
    "type":"object",
    "properties":{
        "AllowRespCommentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether comments are allowed for the question response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentAllowed":{
            "title":"Response Attachments",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether response attachments are required, optional, or not allowed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentAllowedCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for whether the response attachment is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BranchLevel":{
            "type":"integer",
            "description":"Indicates the level at which the question appears in the questionnaire.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for identifying the categorization of the supplier attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The question display number in the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayPreferredRespFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a preferred response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAccResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent acceptable response on which the question is based.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentQuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent question of a questionnaire question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentQuestnaireQuestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent questionnaire question.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredResponseDate":{
            "title":"Preferred Response",
            "type":"string",
            "description":"Value of the preferred response in Date format.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseDatetime":{
            "title":"Preferred Response",
            "type":"string",
            "description":"Value of the preferred response in Date and Time format.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseNumber":{
            "title":"Preferred Response",
            "type":"number",
            "description":"Value of the preferred response in Number format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredResponseText":{
            "title":"Preferred Response",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the preferred response in Text format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionHint":{
            "title":"Hint",
            "maxLength":1000,
            "type":"string",
            "description":"Hint to the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionLevel":{
            "title":"Question Level",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the question is relevant to a supplier or to a supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionLevelCode":{
            "title":"Question Level",
            "maxLength":30,
            "type":"string",
            "description":"Code to specify the question level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionName":{
            "title":"Question",
            "maxLength":80,
            "type":"string",
            "description":"Name of the questionnaire question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionText":{
            "title":"Question Text",
            "type":"string",
            "description":"Text of the question to be displayed to responders of a questionnaire.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionType":{
            "title":"Question Type",
            "maxLength":80,
            "type":"string",
            "description":"Specifies whether the question is a multiple choice question with single selection, a multiple choice question with multiple selections, or a text entry box question without predefined acceptable responses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionTypeCode":{
            "title":"Question Type",
            "maxLength":30,
            "type":"string",
            "description":"Code to specify the question type.",
            "nullable":false,
            "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
        },
        "QuestnaireQuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a questionnaire question.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuestnaireSectionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire section.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseRequiredFlag":{
            "title":"Response Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the response is required for the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseType":{
            "title":"Response Type",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the response type for questions of text entry box type, such as text, number or date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to indicate the response type for questions of text entry box type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAttributeCode":{
            "title":"Supplier Attribute",
            "maxLength":35,
            "type":"string",
            "description":"Code to uniquely identify the supplier attribute that the question is mapped to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAttributeFlag":{
            "title":"Mapped to Supplier Attribute",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the question is mapped to an attribute from the supplier profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAttributeName":{
            "title":"Supplier Site Attribute",
            "maxLength":200,
            "type":"string",
            "description":"Indicates the supplier attribute that the question is mapped to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionnaireAcceptableResponses":{
            "title":"Acceptable Responses",
            "type":"array",
            "description":"Initiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.",
            "items":{
                "$ref":"#/components/schemas/supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireAcceptableResponses-item-response"
            }
        },
        "questionnaireQuestionAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireQuestionAttachments-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 : Acceptable Responses

Type: array

Title: Acceptable Responses

Initiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.

Show Source

• Array of: object supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireAcceptableResponses-item-response

{
    "title":"Acceptable Responses",
    "type":"array",
    "description":"Initiatives for creating, managing, and tracking the qualifications and assessments of your suppliers are handled.",
    "items":{
        "$ref":"#/components/schemas/supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireAcceptableResponses-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 supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireQuestionAttachments-item-response

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

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 : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireAcceptableResponses-item-response

Type: object

Show Source

• AccResponseId: integer (int64)
  Read Only: true

  Value that uniquely identifies the question acceptable response.
• DisplayNumber: string
  Read Only: true

  Maximum Length: 5

  The display number for the acceptable response to the questionnaire question.
• HasBranchingFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the acceptable response has a questionnaire branching question. This attribute doesn't have a default value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionId: integer (int64)
  Value that uniquely identifies a questionnaire question.
• QuestnaireAccResponseId: integer (int64)
  Value that uniquely identifies the questionnaire question's acceptable response.
• QuestnaireId: integer (int64)
  Value that uniquely identifies the questionnaire.

{
    "type":"object",
    "properties":{
        "AccResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the question acceptable response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayNumber":{
            "maxLength":5,
            "type":"string",
            "description":"The display number for the acceptable response to the questionnaire question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HasBranchingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the acceptable response has a questionnaire branching question. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies a questionnaire question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestnaireAccResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire question's acceptable response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuestnaireId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire.",
            "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 : supplierInitiatives-questionnaires-questionnaireSections-questionnaireQuestions-questionnaireQuestionAttachments-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

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• 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

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

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

  Date when the content in the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the attached file.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attachment.
• 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

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment.
• 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

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

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

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the topology manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that identifies the web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when creating 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":"Value that uniquely identifies 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":"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":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies 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":"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":"Value that uniquely identifies the attached document.",
            "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":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "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":"Abbreviation that identifies 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":"Text of 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":"Date when the content in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"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":"Name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "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":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "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":"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":"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":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the 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":"URL (Uniform Resource Locator) that identifies the 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":"Login that the user used when creating 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"
    }
}

Back to Top