Create all communication template attachments
post
/fscmRestApi/resources/11.13.18.05/publicSectorTemplateAttachments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this attachment applies. -
AttachmentEntityName: string
Default Value:
PSC_DOC_TEMPL
The entity name of the attachment. -
AttachmentId: integer
(int64)
The unique identifier for a template attachment.
-
AttachmentType: string
Maximum Length:
15
Default Value:TEMPL
The type of attachment, such as for plan reviews, event template etc. -
CommTemplatesAttAccessor: array
Communication Template Attachments Accessors
Title:
Communication Template Attachments Accessors
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The date and time when the attachment was last updated. -
Description: string
Title:
Description
Maximum Length:100
The description of the attachment. -
DocCategory: string
Maximum Length:
30
The category used for dividing the attached document into a logical group. -
DocSubcategory: string
Maximum Length:
30
The subcategory used for dividing the attached document into a logical group along with the category. -
DocumentKey: integer
(int64)
Unique key associated with the document
-
FileName(required): string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize(required): integer
(int64)
Title:
File Size
The size of the attached file. -
FileType: string
Maximum Length:
100
The name of the attached file. -
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
RequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
TemplateId(required): integer
(int64)
Unique id for a event template
-
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version(required): integer
(int32)
The version of the attachment.
Nested Schema : Communication Template Attachments Accessors
Type:
array
Title:
Communication Template Attachments Accessors
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier for an attachment. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachment revision resource is used to view attachment revisions. -
CategoryName: string
Title:
Category
Maximum Length:30
The unique name given to the communication attachment file-related information, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
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 of the attachment file. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
The JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached file. -
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 such as plain text or comma-separated value format. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment revision resource is used to view attachment revisions.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
The date when the file was attached.
-
RevisionId: string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an attachment revision.
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.
Root Schema : publicSectorTemplateAttachments-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this attachment applies. -
AttachmentEntityName: string
Default Value:
PSC_DOC_TEMPL
The entity name of the attachment. -
AttachmentId: integer
(int64)
The unique identifier for a template attachment.
-
AttachmentType: string
Maximum Length:
15
Default Value:TEMPL
The type of attachment, such as for plan reviews, event template etc. -
CommTemplatesAttAccessor: array
Communication Template Attachments Accessors
Title:
Communication Template Attachments Accessors
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL -
ConfidentialFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a confidential document. The default value is N for no. -
CreatedByName: string
Title:
Uploaded By
The date and time when the attachment was last updated. -
CreationDate: string
(date-time)
Title:
Uploaded On
Read Only:true
The file type of attachment, such as PDF or text. -
Description: string
Title:
Description
Maximum Length:100
The description of the attachment. -
DocCategory: string
Maximum Length:
30
The category used for dividing the attached document into a logical group. -
DocSubcategory: string
Maximum Length:
30
The subcategory used for dividing the attached document into a logical group along with the category. -
DocumentKey: integer
(int64)
Unique key associated with the document
-
FileName: string
Title:
File Name
Maximum Length:255
The name of the attached file. -
FileSize: integer
(int64)
Title:
File Size
The size of the attached file. -
FileType: string
Maximum Length:
100
The name of the attached file. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the attachment was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Preview: string
(byte)
This column contains the thumbnail of an attached file.
-
PreviewHeight: number
This column indicates the height of a stored thumbnail.
-
PreviewWidth: number
This column indicates the width of a stored thumbnail.
-
RequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the attachment is a required document. The default value is N for no. -
TemplateId: integer
(int64)
Unique id for a event template
-
UpdatedByName: string
Title:
Last Updated By
The user who last updated the attachment. -
Version: integer
(int32)
The version of the attachment.
Nested Schema : Communication Template Attachments Accessors
Type:
array
Title:
Communication Template Attachments Accessors
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorTemplateAttachments-CommTemplatesAttAccessor-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier for an attachment. -
AttachmentsRevision: array
Attachment Revisions
Title:
Attachment Revisions
The attachment revision resource is used to view attachment revisions. -
CategoryName: string
Title:
Category
Maximum Length:30
The unique name given to the communication attachment file-related information, which makes the attachment functionality work in conjunction with the entity name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The datatype code of the attachment. -
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 of the attachment file. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
The JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code that indicates the error status of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The message that describes the error status of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date of expiration of the attachment. -
FileContents: string
(byte)
Title:
File Contents
The file contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attached file. -
FileUrl: string
Title:
File Url
The URL or web address of the attached 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 and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment such as plain text or comma-separated value format. -
UploadedFileLength: integer
Title:
File Size
The file length of the attachment in bytes. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text that is entered along with the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The type of universal resource identifier (URI) associated with the attachment. For example, URL. -
Url: string
Title:
Url
Maximum Length:4000
The URL associated with an attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The user's unique user name for logging into the system.
Nested Schema : Attachment Revisions
Type:
array
Title:
Attachment Revisions
The attachment revision 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 : publicSectorTemplateAttachments-CommTemplatesAttAccessor-AttachmentsRevision-item-response
Type:
Show Source
object
-
AttachedDocumentId: string
Read Only:
true
The unique identifier of an attached document. -
ContentId: string
Maximum Length:
80
The unique identifier of the attachment content. -
ErrorStatusCode: string
The code that indicates the error status of the attachment.
-
ErrorStatusMessage: string
The message that describes the error status of the attachment.
-
FileUrl: string
The web address for an attached file.
-
Format: string
Maximum Length:
128
The format of the attachment. -
InDate: string
(date-time)
The date when the file was attached.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: string
Maximum Length:
80
The unique identifier of the attachment revision. -
RevLabel: string
Maximum Length:
80
The label for an attachment revision. -
UserRevisionId: integer
The unique identifier for an 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.
Links
- CommTemplatesAttAccessor
-
Parameters:
- DocumentKey:
$request.path.DocumentKey
The communication template attachment accessors resource is used for displaying communication attachment file-related information such as file name and file URL - DocumentKey: