Create an attachment
post
/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments
Request
Path Parameters
- projectEnterpriseLaborResourcesUniqID(required): string This is the hash key of the attributes which make up the composite key for the Project Enterprise Labor Resources resource and used to uniquely identify an instance of Project Enterprise Labor Resources. The client should not generate the hash key value. Instead, the client should query on the Project Enterprise Labor Resources collection resource in order to navigate to a specific instance of Project Enterprise Labor Resources to get the hash key.
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.
- Upsert-Mode: string 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- 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
- 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. - 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.
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 : projectEnterpriseLaborResources-Attachments-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.