Request to download a document template
post
/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandUploads/action/downloadTemplate
Downloads a customer demand template for the specified document.
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.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
DocumentTypeCode: string
Abbreviation that identifies the type of document used for collaboration.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Value that indicates if the action was successful or not.
Examples
This example describes how to request downloading a document template.
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.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationCustomerDemandUploads/"
Example Request Body
The following example includes the contents of the request body in JSON format:
{ "name":"downloadTemplate", "parameters": [ { "DocumentTypeCode":"VCS_FORECAST" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "result": "IkN1c3RvbWVyIE51bWJlciI..." }