Get all credential attachments
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordCredentialAttachments
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 credential attachment that matches the primary keys specified.
Finder Variables:- AttachmentId; integer.
- LnpCredentialAtchKey; integer; The unique identifier for the attached document.
- simpleSearchFinder: Finds the credential attachment that matches the specified filter values.
Finder Variables:- value; string; The filter values for finding an attachment such as file name, and description.
- PrimaryKey: Finds the credential attachment that matches the primary keys specified.
-
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:- AgencyId; integer; The unique identifier for a public sector agency.
- AttachmentEntityName; string; The entity name of the attached document.
- AttachmentId; integer; The attachment ID from the common attachment table.
- AttachmentType; string; The attachment type. The value is CRED for contractor attachments.
- CreatedByName; string; The user name who created the document.
- CreationDate; string; The date and time that the attachment was created.
- CredentialAttachmentId; integer; The attachment ID from the common attachment table.
- Description; string; The description of the attachment.
- DocCategory; string; The category for an attached document.
- DocSubcategory; string; The subcategory for an attached document.
- FileName; string; The file name of the attachment.
- FileSize; integer; The file size of the attachment.
- FileType; string; The type of the attachment file such as text/plain, or image/jpeg.
- LastUpdateDate; string; The date and time that the attachment was last updated.
- LnpCredentialAtchKey; integer; The unique identifier for the attached document.
- LnpCredentialAtchPuid; string; PUID for this record. Alternate key used by CRM Import.
- LnpCredentialKey; integer; Unique identifier for a credential in a transaction.
- LnpCredentialPuid; string; Indicates the PUID for credential object. Used by CRM Import.
- LnpRecordId; string; Indicates the meaningful transaction identifier.
- LnpRecordKey; integer; Unique identifier for the related transaction.
- PreviewHeight; number; Indicates the height of a stored thumbnail.
- PreviewWidth; number; Indicates the width of a stored thumbnail.
- UpdatedByName; string; The user name who last modified the document.
- Version; integer; Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
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:
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.
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(required):
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(required):
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 : publicSectorRecordCredentialAttachments
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:
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordCredentialAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency. -
AttachmentEntityName: string
Default Value:
PSC_DOC_CRED
The entity name of the attached document. -
AttachmentId: integer
(int64)
The attachment ID from the common attachment table.
-
AttachmentType: string
Maximum Length:
15
Default Value:CRED
The attachment type. The value is CRED for contractor attachments. -
CreatedByName: string
Title:
Uploaded By
The user name who created the document. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The date and time that the attachment was created. -
CredentialAttachmentAccessor: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CredentialAttachmentId: integer
(int64)
The attachment ID from the common attachment table.
-
Description: string
Title:
Description
Maximum Length:100
The description of the attachment. -
DocCategory: string
Maximum Length:
30
The category for an attached document. -
DocSubcategory: string
Maximum Length:
30
The subcategory for an attached document. -
FileName: string
Title:
File Name
Maximum Length:255
The file name of the attachment. -
FileSize: integer
(int64)
Title:
File Size
The file size of the attachment. -
FileType: string
Maximum Length:
100
The type of the attachment file such as text/plain, or image/jpeg. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the attachment was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpCredentialAtchKey: integer
(int64)
The unique identifier for the attached document.
-
LnpCredentialAtchPuid: string
Maximum Length:
480
PUID for this record. Alternate key used by CRM Import. -
LnpCredentialKey: integer
(int64)
Unique identifier for a credential in a transaction.
-
LnpCredentialPuid: string
Maximum Length:
480
Indicates the PUID for credential object. Used by CRM Import. -
LnpRecordId: string
Maximum Length:
50
Indicates the meaningful transaction identifier. -
LnpRecordKey: integer
(int64)
Unique identifier for the related transaction.
-
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
Indicates the height of a stored thumbnail.
-
PreviewWidth: number
Indicates the width of a stored thumbnail.
-
UpdatedByName: string
Title:
Last Updated By
The user name who last modified the document. -
Version: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordCredentialAttachments-CredentialAttachmentAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An attribute exclusively used by the Attachment UI components when uploading the files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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
Name of the user 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
Indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document identifier 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, when 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
Name of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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 for assigning 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.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachmentsRevision resource is used to view attachment revisions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordCredentialAttachments-CredentialAttachmentAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of the attached document for this revision. -
ContentId: string
Maximum Length:
80
The contents of the attachment revision. -
ErrorStatusCode: string
The error code, if any, for the attachment revision.
-
ErrorStatusMessage: string
The error message, if any, for the attachment revision.
-
FileUrl: string
The file name of the attachment revision.
-
Format: string
Maximum Length:
128
The format of the attachment revision. -
InDate: string
(date-time)
The date of the attachment revision.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The revision label of the attachment revision. -
UserRevisionId: integer
The user revision identifier for the attachment revision.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.