Jump to

• Request
• Response

Get all questionnaire responses

get

/fscmRestApi/resources/11.13.18.05/questionResponsesInSupplierPortal

Request

Query Parameters

• 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 Finds the response according to the specified question.
    Finder Variables
    • ResponseRepositoryId; integer; Value that uniquely identifies the response in the response repository.
• 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:
  

  • OriginalQuestionId; integer; Indicates the original question for the question revision for which this is a response.
  • Question; string; Name of the question.
  • QuestionId; integer; Value that uniquely identifies the question in question library.
  • ResponseRepositoryId; integer; Value that uniquely Identifies the response repository row.
  • ResponseStatus; string; Indicates the status of the response to a question.
  • ResponseStatusCode; string; Code for the status of the response to questionnaire.
  • Supplier; string; Name of the supplier.
  • SupplierContact; string; Name of the supplier contact.
  • SupplierContactId; integer; Value that uniquely identifies the supplier contact.
  • SupplierId; integer; Value that uniquely Identifies the Supplier who's being responded.
  • SupplierSite; string; Name of the supplier site.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site on the response.
• 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 : questionResponsesInSupplierPortal

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/questionResponsesInSupplierPortal-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object questionResponsesInSupplierPortal-item-response

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

Type: object

Show Source

• businessClassifications: array Supplier Business Classifications
  Title: Supplier Business Classifications

  List of supplier's business classifications.
• FirstSubmissionDate: string (date-time)
  Title: First Submission Date

  Read Only: true

  Indicates the date when the response was first submitted.
• links: array Links
  Title: Links

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

  Indicates the original question for the question revision for which this is a response.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.
• ProcurementBUId: integer
  Default Value: -9999

  Value that uniquely identifies the procurement business unit.
• Question: string
  Title: Question

  Read Only: true

  Maximum Length: 80

  Name of the question.
• QuestionId: integer (int64)
  Value that uniquely identifies the question in question library.
• QuestionRevision: integer (int32)
  Title: Question Revision

  Read Only: true

  Revision number of the question.
• QuestionText: string (byte)
  Title: Question Text

  Read Only: true

  Text of the question to be displayed to responders of a questionnaire.
• ResponderComments: string
  Title: Responder Comments

  Maximum Length: 1000

  Indicates the text of a manually entered response comments value.
• ResponseArchiveDate: string (date-time)
  Title: Response Archive Date

  Read Only: true

  Date when this response got archived because a new response got entered in the repository.
• ResponseDate: string (date-time)
  Title: Response Date

  Date when the response to a questionnaire is submitted.
• ResponseRepositoryId: integer (int64)
  Read Only: true

  Value that uniquely Identifies the response repository row.
• ResponseStatus: string
  Title: Response Status

  Read Only: true

  Maximum Length: 80

  Indicates the status of the response to a question.
• ResponseStatusCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: PROCESSING

  Code for the status of the response to questionnaire.
• 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.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier.
• SupplierContact: string
  Title: Responder

  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 who's being responded.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site on the response.
• values: array Response Values
  Title: Response Values

  Store for the questionnaire response value for each question in the questionnaire.

{
    "type":"object",
    "properties":{
        "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":false
        },
        "values":{
            "title":"Response Values",
            "type":"array",
            "description":"Store for the questionnaire response value for each question in the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionResponsesInSupplierPortal-values-item-response"
            }
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierContact":{
            "title":"Responder",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseRepositoryId":{
            "type":"integer",
            "description":"Value that uniquely Identifies the response repository row.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResponseStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the status of the response to questionnaire.",
            "nullable":false,
            "readOnly":true,
            "default":"PROCESSING",
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site on the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponderComments":{
            "title":"Responder Comments",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the text of a manually entered response comments 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"
            }
        },
        "Question":{
            "title":"Question",
            "maxLength":80,
            "type":"string",
            "description":"Name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier.",
            "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
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true,
            "default":-9999,
            "x-queryable":false
        },
        "ResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"Date when the response to a questionnaire is submitted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "QuestionRevision":{
            "title":"Question Revision",
            "type":"integer",
            "description":"Revision number of the question.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "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":false
        },
        "FirstSubmissionDate":{
            "title":"First Submission Date",
            "type":"string",
            "description":"Indicates the date when the response was first submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely Identifies the Supplier who's being responded.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseStatus":{
            "title":"Response Status",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the status of the response to a question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the question in question library.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ProcurementBUId",
                    "Supplier"
                ]
            },
            "x-queryable":true
        },
        "businessClassifications":{
            "title":"Supplier Business Classifications",
            "type":"array",
            "description":"List of supplier's business classifications.",
            "items":{
                "$ref":"#/components/schemas/questionResponsesInSupplierPortal-businessClassifications-item-response"
            }
        },
        "OriginalQuestionId":{
            "type":"integer",
            "description":"Indicates the original question for the question revision for which this is a response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseArchiveDate":{
            "title":"Response Archive Date",
            "type":"string",
            "description":"Date when this response got archived because a new response got entered in the repository.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Supplier Business Classifications

Type: array

Title: Supplier Business Classifications

List of supplier's business classifications.

Show Source

• Array of: object questionResponsesInSupplierPortal-businessClassifications-item-response

{
    "title":"Supplier Business Classifications",
    "type":"array",
    "description":"List of supplier's business classifications.",
    "items":{
        "$ref":"#/components/schemas/questionResponsesInSupplierPortal-businessClassifications-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 : Response Values

Type: array

Title: Response Values

Store for the questionnaire response value for each question in the questionnaire.

Show Source

• Array of: object questionResponsesInSupplierPortal-values-item-response

{
    "title":"Response Values",
    "type":"array",
    "description":"Store for the questionnaire response value for each question in the questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionResponsesInSupplierPortal-values-item-response"
    }
}

Nested Schema : questionResponsesInSupplierPortal-businessClassifications-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

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

  Maximum Length: 80

  Certificate number of the certificate granted to the supplier for the classification.
• CertifyingAgency: string
  Title: Certifying Agency

  Read Only: true

  Maximum Length: 255

  Name of the certifying agency that granted the business classification to the supplier.
• CertifyingAgencyId: integer (int64)
  Title: Certifying Agency ID

  Value that uniquely Identifies the certifying agency that granted the business classification certificate to the supplier.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  Indicates the business classification.
• ClassificationCode: string
  Title: Classification Code

  Maximum Length: 30

  Indicates the lookup code for the business classification type.
• ClassificationId: integer (int64)
  Title: Classification ID

  Indicates the classification identifier on the POZ_BUS_CLASSIFICATIONS table.
• ConfirmedOn: string (date)
  Title: Confirmed On

  Indicates the date on which the classification row is last updated.
• ExpirationDate: string (date)
  Title: Expiration Date

  Indicates the Expiration date of the certificate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: string
  Title: Notes

  Maximum Length: 1000

  Indicates any additional information regarding the classification.
• OtherCertifyingAgency: string
  Title: Other Certifying Agency

  Maximum Length: 255

  Field to capture other certifying agencies apart from those in the list.
• PozVersionNumber: integer (int32)
  Title: POZ Business Classification Version

  Indicates the value of the object version number on the corresponding POZ_BUS_CLASSIFICATIONS row.
• ProvidedByContact: string
  Title: Provided By

  Read Only: true

  Maximum Length: 255

  Name of the supplier contact who provided the classification information.
• ProvidedByContactId: integer (int64)
  Title: Provided By ID

  Value that uniquely Identifies the supplier contact who has provided the classification information.
• ResponseRepositoryId: integer (int64)
  Title: Response Repository ID

  Value that uniquely Identifies the response repository row.
• RespReposBusClassId: integer (int64)
  Title: Response Repository Business Classification ID

  Value that uniquely identifies response repository business classification.
• StartDate: string (date)
  Title: Start Date

  Indicates the start date of the business classification certificate.
• Status: string
  Title: Classification Status

  Read Only: true

  Maximum Length: 255

  Indicates the status of the supplier classification.
• StatusCode: string
  Title: Classification Status Code

  Read Only: true

  Maximum Length: 255

  Code for the status of the supplier classification.
• SubClassification: string
  Title: SubClassification

  Read Only: true

  Maximum Length: 80

  Indicates the minority owned classification type.
• SubClassificationCode: string
  Title: SubClassification Code

  Maximum Length: 240

  Indicates the lookup code for the minority owned business classification type.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Classification Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the status of the supplier classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CertifyingAgency":{
            "title":"Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Name of the certifying agency that granted the business classification to the supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionResponsesInSupplierPortal-businessClassifications-attachments-item-response"
            }
        },
        "ConfirmedOn":{
            "title":"Confirmed On",
            "type":"string",
            "description":"Indicates the date on which the classification row is last updated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertifyingAgencyId":{
            "title":"Certifying Agency ID",
            "type":"integer",
            "description":"Value that uniquely Identifies the certifying agency that granted the business classification certificate to the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubClassification":{
            "title":"SubClassification",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the minority owned classification type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProvidedByContactId":{
            "title":"Provided By ID",
            "type":"integer",
            "description":"Value that uniquely Identifies the supplier contact who has provided the classification information.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Classification Status Code",
            "maxLength":255,
            "type":"string",
            "description":"Code for the status of the supplier classification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseRepositoryId":{
            "title":"Response Repository ID",
            "type":"integer",
            "description":"Value that uniquely Identifies the response repository row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationId":{
            "title":"Classification ID",
            "type":"integer",
            "description":"Indicates the classification identifier on the POZ_BUS_CLASSIFICATIONS table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Indicates the start date of the business classification certificate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProvidedByContact":{
            "title":"Provided By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact who provided the classification information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RespReposBusClassId":{
            "title":"Response Repository Business Classification ID",
            "type":"integer",
            "description":"Value that uniquely identifies response repository business classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Indicates the Expiration date of the certificate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the lookup code for the business classification type.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the business classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CertificateNumber":{
            "title":"Certificate",
            "maxLength":80,
            "type":"string",
            "description":"Certificate number of the certificate granted to the supplier for the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubClassificationCode":{
            "title":"SubClassification Code",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the lookup code for the minority owned business classification type.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherCertifyingAgency":{
            "title":"Other Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Field to capture other certifying agencies apart from those in the list.",
            "nullable":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates any additional information regarding the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "PozVersionNumber":{
            "title":"POZ Business Classification Version",
            "type":"integer",
            "description":"Indicates the value of the object version number on the corresponding POZ_BUS_CLASSIFICATIONS row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object questionResponsesInSupplierPortal-businessClassifications-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionResponsesInSupplierPortal-businessClassifications-attachments-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 : questionResponsesInSupplierPortal-businessClassifications-attachments-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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of 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
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "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"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : questionResponsesInSupplierPortal-values-item-response

Type: object

Show Source

• AcceptableResponseId: integer (int64)
  Value that uniquely identifies the questionnaire acceptable response.
• AcceptableResponseText: string
  Title: Acceptable Response Text

  Maximum Length: 1000

  The text of a manually entered acceptable response value.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CriticalResponseFlag: boolean
  Title: Critical Response

  Maximum Length: 1

  Indicates if the response is critical for supplier evaluation.
• links: array Links
  Title: Links

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

  Value that uniquely Identifies the qualification response.
• ResponseRepositoryValueId: integer (int64)
  Read Only: true

  Value that uniquely identifies a qualification response value.
• ResponseValueDate: string (date)
  Title: Response Date

  Indicates the response value for a question setup with response type as date.
• ResponseValueDatetime: string (date-time)
  Indicates the response value for a question setup with response type as date and time.
• ResponseValueNumber: number
  Title: Response Number

  Indicates the numeric value of a manually entered question response.
• ResponseValueText: string
  Title: Response Text

  Maximum Length: 4000

  Indicates the text of a manually entered question response value.

{
    "type":"object",
    "properties":{
        "ResponseRepositoryValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies a qualification response value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/questionResponsesInSupplierPortal-values-attachments-item-response"
            }
        },
        "AcceptableResponseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the questionnaire acceptable response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "ResponseValueDatetime":{
            "type":"string",
            "description":"Indicates the response value for a question setup with response type as date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CriticalResponseFlag":{
            "title":"Critical Response",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the response is critical for supplier evaluation.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseValueText":{
            "title":"Response Text",
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the text of a manually entered question response value.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseRepositoryId":{
            "type":"integer",
            "description":"Value that uniquely Identifies the qualification response.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseValueDate":{
            "title":"Response Date",
            "type":"string",
            "description":"Indicates the response value for a question setup with response type as date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "AcceptableResponseText":{
            "title":"Acceptable Response Text",
            "maxLength":1000,
            "type":"string",
            "description":"The text of a manually entered acceptable response value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseValueNumber":{
            "title":"Response Number",
            "type":"number",
            "description":"Indicates the numeric value of a manually entered question response.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object questionResponsesInSupplierPortal-values-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/questionResponsesInSupplierPortal-values-attachments-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 : questionResponsesInSupplierPortal-values-attachments-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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of 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
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "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"
            }
        }
    }
}

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