Get all question responses
get
/fscmRestApi/resources/11.13.18.05/supplierQualifications/{supplierQualificationsUniqID}/child/responses
Request
Path Parameters
-
supplierQualificationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Qualifications resource and used to uniquely identify an instance of Supplier Qualifications. The client should not generate the hash key value. Instead, the client should query on the Supplier Qualifications collection resource in order to navigate to a specific instance of Supplier Qualifications 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 Finds qualification question response records according to the specified primary key.
Finder Variables- QualResponseId; integer; Value that uniquely identifies the qualification response.
- PrimaryKey Finds qualification question response records according to the specified primary key.
-
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:- CriticalQuestionFlag; boolean; Indicates whether a question is critical for evaluation.
- MaximumScore; number; Maximum score for the question.
- QualResponseId; integer; Value that uniquely identifies the qualification response.
- QualificationId; integer; Value that uniquely identifies the qualification.
- QuestionId; integer; Value that uniquely identifies the Question.
- QuestionLevelCode; string; Code to specify the question level.
- QuestionName; string; Name of the question.
- QuestionTypeCode; string; Code to specify the question type.
- ResponderTypeCode; string; Code to specify the responder type.
- ResponseRepositoryId; integer; A value that uniquely identifies a response from response repository.
- ResponseSubmissionDate; string; Indicates the date the responder submitted the response to the question.
- ScoringMethod; string; Species the scoring method used for a question. The system validates the scoring method against the lookup FND_LOOKUP for POQ_QUESTION_SCORING_METHOD.
- ScoringMethodCode; string; Indicates the code used to identify the scoring method to be used for this question.
-
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 TopResponse
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.
Root Schema : supplierQualifications-responses
Type:
Show Source
object-
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualifications-responses-item-response
Type:
Show Source
object-
AcceptanceNote: string
Title:
Acceptance NoteRead Only:trueMaximum Length:1000Indicates the comments provided by the acceptor in response to a question. -
businessClassifications: array
Supplier Business Classifications
Title:
Supplier Business ClassificationsList of supplier's business classifications. -
CriticalQuestionFlag: boolean
Title:
Critical QuestionRead Only:trueMaximum Length:1Indicates whether a question is critical for evaluation. -
DisplayPreferredResponseFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether there is a preferred response. -
EvaluationNote: string
Title:
Evaluation NoteMaximum Length:1000Indicates the comments provided by the evaluator in response to a question. -
FromUI: string
Maximum Length:
1Default Value:NIndicates whether the response is provided by a REST resource or through Oracle Visual Builder Cloud Service. -
KnockoutScore: number
Title:
Knockout ScoreRead Only:trueSpecifies the knockout score for the question when the question has a scoring type of automatic or manual. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumScore: number
Title:
Maximum ScoreRead Only:trueMaximum score for the question. -
OriginalQuestionId: integer
(int64)
Read Only:
trueIndicates the original question for the question revision for which this is a response. -
PreferredAcceptableResponseText: string
Read Only:
trueMaximum Length:1000Preferred text for a response value. -
PreferredResponseDate: string
(date)
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Date format. -
PreferredResponseDatetime: string
(date-time)
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Date and Time format. -
PreferredResponseNumber: number
Title:
Preferred ResponseRead Only:trueValue of the preferred response in Number format. -
PreferredResponseText: string
Title:
Preferred ResponseRead Only:trueMaximum Length:4000Value of the preferred response in Text format. -
QualificationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the qualification. -
QualResponseId: integer
(int64)
Value that uniquely identifies the qualification response.
-
QuestionAttachmentExistsFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether there is a question attachment. -
questionAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
QuestionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the Question. -
QuestionLevel: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates whether the question is relevant to a supplier or to a supplier site. -
QuestionLevelCode: string
Title:
Question LevelRead Only:trueMaximum Length:30Code to specify the question level. -
QuestionName: string
Title:
QuestionRead Only:trueMaximum Length:80Name of the question. -
QuestionRevision: integer
(int32)
Title:
RevisionRead Only:trueRevision number of the question. -
QuestionText: string
(byte)
Title:
Question TextRead Only:trueText of the question to be displayed to responders of a questionnaire. -
QuestionType: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates the type of question. -
QuestionTypeCode: string
Title:
Question TypeRead Only:trueMaximum Length:30Code to specify the question type. -
QuestionWeight: number
Title:
WeightRead Only:trueIndicates the importance of the question in the qualification area. It's used to calculate the overall score of the qualification. -
ReassignedWeight: number
Read Only:
trueValue that identifies the reassigned weight of a question after one or more questions in the qualification was excluded from scoring. -
ResponderType: string
Title:
Responder TypeRead Only:trueMaximum Length:80Indicates whether the question responder is a supplier or an internal user. -
ResponderTypeCode: string
Title:
Responder Type CodeRead Only:trueMaximum Length:30Code to specify the responder type. -
ResponseComments: string
Title:
Responder CommentsRead Only:trueMaximum Length:1000Indicates the text value of manually added qualification comments. -
ResponseDate: string
(date-time)
Title:
Response DateRead Only:trueIndicates the date when the response was submitted. -
ResponseHistoryFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether there is a response history for the question. -
ResponseRepositoryId: integer
(int64)
Read Only:
trueA value that uniquely identifies a response from response repository. -
ResponseRequiredFlag: boolean
Title:
Response RequiredRead Only:trueMaximum Length:1Indicates whether the response is required for the question. -
ResponseScore: number
Title:
ScoreA value that indicates the calculated response score of parent questions in a qualification. -
ResponseStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates the status of the response to a question. -
ResponseStatusCode: string
Title:
Response StatusRead Only:trueMaximum Length:30Code to specify the response status. -
ResponseSubmissionDate: string
(date-time)
Title:
Response DateRead Only:trueIndicates the date the responder submitted the response to the question. -
ResponseType: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates the response type for questions of text entry box type, such as text, number or date. -
ResponseTypeCode: string
Read Only:
trueMaximum Length:30Code to indicate the response type for questions of text entry box type. -
ScoringMethod: string
Title:
ScoringRead Only:trueMaximum Length:80Species the scoring method used for a question. The system validates the scoring method against the lookup FND_LOOKUP for POQ_QUESTION_SCORING_METHOD. -
ScoringMethodCode: string
Title:
ScoringRead Only:trueMaximum Length:30Indicates the code used to identify the scoring method to be used for this question. -
SupplierAttributeCategory: string
Title:
MeaningRead Only:trueMaximum Length:80Indicates the supplier products and services category. -
SupplierAttributeCategoryCode: string
Read Only:
trueMaximum Length:30Code to uniquely identify the supplier products and services category. -
SupplierAttributeCode: string
Title:
Supplier AttributeRead Only:trueMaximum Length:35Code to uniquely identify the supplier attribute that the question is mapped to. -
SupplierAttributeName: string
Read Only:
trueMaximum Length:200Indicates the supplier attribute that the question is mapped to. -
values: array
Response Values
Title:
Response ValuesStore for the questionnaire response value for each question in the questionnaire. -
WeightedScore: number
Title:
Weighted ScoreRead Only:trueIndicates the weighted score calculated for the question in the qualification process.
Nested Schema : Supplier Business Classifications
Type:
arrayTitle:
Supplier Business ClassificationsList of supplier's business classifications.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Response Values
Type:
arrayTitle:
Response ValuesStore for the questionnaire response value for each question in the questionnaire.
Show Source
Nested Schema : supplierQualifications-responses-businessClassifications-item-response
Type:
Show Source
object-
businessClassificationAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CertificateNumber: string
Title:
CertificateMaximum Length:80Certificate number of the certificate granted to the supplier for the classification. -
CertifyingAgency: string
Title:
Certifying AgencyRead Only:trueMaximum Length:255Name of the certifying agency that granted the business classification to the supplier. -
CertifyingAgencyId: integer
(int64)
Title:
Certifying Agency IDValue that uniquely Identifies the certifying agency that granted the business classification certificate to the supplier. -
Classification: string
Title:
ClassificationRead Only:trueMaximum Length:80Indicates the business classification. -
ClassificationCode: string
Title:
Classification CodeMaximum Length:30Indicates the lookup code for the business classification type. -
ClassificationId: integer
(int64)
Title:
Classification IDIndicates the classification identifier on the POZ_BUS_CLASSIFICATIONS table. -
ConfirmedOn: string
(date)
Title:
Confirmed OnIndicates the date on which the classification row is last updated. -
ExpirationDate: string
(date)
Title:
Expiration DateIndicates the Expiration date of the certificate. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Notes: string
Title:
NotesMaximum Length:1000Indicates any additional information regarding the classification. -
OtherCertifyingAgency: string
Title:
Other Certifying AgencyMaximum Length:255Field to capture other certifying agencies apart from those in the list. -
PozVersionNumber: integer
(int32)
Title:
POZ Business Classification VersionIndicates the value of the object version number on the corresponding POZ_BUS_CLASSIFICATIONS row. -
ProvidedByContact: string
Title:
Provided ByRead Only:trueMaximum Length:255Name of the supplier contact who provided the classification information. -
ProvidedByContactId: integer
(int64)
Title:
Provided By IDValue that uniquely Identifies the supplier contact who has provided the classification information. -
ResponseRepositoryId: integer
(int64)
Title:
Response Repository IDValue that uniquely Identifies the response repository row. -
RespReposBusClassId: integer
(int64)
Title:
Response Repository Business Classification IDValue that uniquely identifies response repository business classification. -
StartDate: string
(date)
Title:
Start DateIndicates the start date of the business classification certificate. -
Status: string
Title:
Classification StatusRead Only:trueMaximum Length:255Indicates the status of the supplier classification. -
StatusCode: string
Title:
Classification Status CodeRead Only:trueMaximum Length:255Code for the status of the supplier classification. -
SubClassification: string
Title:
SubClassificationRead Only:trueMaximum Length:80Indicates the minority owned classification type. -
SubClassificationCode: string
Title:
SubClassification CodeMaximum Length:240Indicates the lookup code for the minority owned business classification type.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualifications-responses-businessClassifications-businessClassificationAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : supplierQualifications-responses-questionAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : supplierQualifications-responses-values-item-response
Type:
Show Source
object-
AcceptableResponseId: integer
(int64)
Value that uniquely identifies the questionnaire acceptable response.
-
AcceptableResponseText: string
Maximum Length:
1000The text of a manually entered acceptable response value. -
CriticalResponseFlag: boolean
Maximum Length:
1Indicates if the response is critical for supplier evaluation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
responseAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ResponseRepositoryId: integer
(int64)
Value that uniquely Identifies the qualification response.
-
ResponseRepositoryValueId: integer
(int64)
Value that uniquely identifies a qualification response value.
-
ResponseValueDate: string
(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
Indicates the numeric value of a manually entered question response.
-
ResponseValueText: string
Maximum Length:
4000Indicates the text of a manually entered question response value.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : supplierQualifications-responses-values-responseAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source