Add multiple attachments to a change request
post
/fscmRestApi/resources/11.13.18.05/productChangeRequests/{productChangeRequestsUniqID}/child/changeRequestAttachments
Request
Path Parameters
-
productChangeRequestsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Change Requests resource and used to uniquely identify an instance of Product Change Requests. The client should not generate the hash key value. Instead, the client should query on the Product Change Requests collection resource in order to navigate to a specific instance of Product Change Requests to get the hash key.
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
-
AttachedDocumentId: integer
(int64)
The unique identifier of the attached document.
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of a change-request attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Unique identifier of the datatype of the attachment. -
Description: string
Title:
Description
Maximum Length:255
An attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
An attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
An attribute value that represents the version number of the attachment in the repository. -
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 status code for the change-request attachment upload. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the change-request attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The attachment expiration date of the change request. -
FileContents: string
(byte)
The contents of the attachment.
-
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the change-request attachment. -
FileUrl: string
Title:
File Url
The file URL of the change-request attachment. -
Title: string
Title:
Title
Attribute value that represents the title of a change-request attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded change-request attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded change-request attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded change-request attachment. -
UploadedText: string
Title:
Uploaded Text
Contents of attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
Attribute value that represents the URI for the attachment. -
Url: string
Title:
Url
Maximum Length:4000
Attribute value that represents the URL for the 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 : productChangeRequests-changeRequestAttachments-item-response
Type:
Show Source
object
-
AttachedDocumentId: integer
(int64)
The unique identifier of the attached document.
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of a change-request attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the change-request attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the change request attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the change object was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Unique identifier of the datatype of the attachment. -
Description: string
Title:
Description
Maximum Length:255
An attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
An attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
An attribute value that represents the version number of the attachment in the repository. -
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 status code for the change-request attachment upload. -
ErrorStatusMessage: string
Title:
Error Status Message
The error status message for the change-request attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The attachment expiration date of the change request. -
FileContents: string
(byte)
The contents of the attachment.
-
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the change-request attachment. -
FileUrl: string
Title:
File Url
The file URL of the change-request attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
An attribute which indicates the date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the change-request attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the change-request attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Attribute value that represents the title of a change-request attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded change-request attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded change-request attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded change-request attachment. -
UploadedText: string
Title:
Uploaded Text
Contents of attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
Attribute value that represents the URI for the attachment. -
Url: string
Title:
Url
Maximum Length:4000
Attribute value that represents the URL for the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Attribute value that represents the name of the user who uploaded the attachment.
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.
Examples
This example describes how to add multiple attachments to a change request.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/"
For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/"
Example Request Body
The following example includes the contents of the request body in JSON format:
{ "DatatypeCode" : "WEB_PAGE", "Description" : "URL added from REST sample", "Title" : "Link to sample.de", "Url" : "https://www.sample.com" }
Example Response Body
The following example includes the contents of the
response body in JSON format:
{ "AttachedDocumentId": 300100548802396, "LastUpdateDate": "2021-11-16T20:27:10.621+00:00", "LastUpdatedBy": "PLM_AUTO", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": "", "DmDocumentId": null, "DmVersionNumber": null, "Url": "https://www.sample.com", "CategoryName": "DOCUMENT", "UserName": null, "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Link to sample.de", "Description": "URL added from REST sample", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "PLM_AUTO", "CreationDate": "2021-11-16T20:27:10+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "AUTO PLM", "CreatedByUserName": "AUTO PLM", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAttachments/00020000000EACED00057708000110F09A9BB75C0000000EACED00057708000110F09A9BB75B", "name": "changeRequestAttachments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAttachments/00020000000EACED00057708000110F09A9BB75C0000000EACED00057708000110F09A9BB75B", "name": "changeRequestAttachments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284", "name": "productChangeRequests", "kind": "item" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAttachments/00020000000EACED00057708000110F09A9BB75C0000000EACED00057708000110F09A9BB75B/enclosure/FileContents", "name": "FileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/productChangeRequests/300100548802284/child/changeRequestAttachments/00020000000EACED00057708000110F09A9BB75C0000000EACED00057708000110F09A9BB75B/enclosure/FileWebImage", "name": "FileWebImage", "kind": "other" } ] }