Jump to

• Request
• Response
• Examples

Generate a request attachment

post

/epm/rest/v1/requests/{requestId}/attachments/generate

Request

Supported Media Types

• application/json

Path Parameters

• requestId: string(uuid)

Body ()

Parameters to use for creating the new import attachment.

Root Schema : Parameters for generating an Excel import attachment for an existing request

Type: object

Show Source

• fileName: string
  The name of the Request Excel File attachment to generate.
• items: array items
  A list of items (rows) to be added to the excel file.
• overwrite(optional): boolean
  If true, an existing Request attachment will be overwritten.

{
    "type":"object",
    "required":[
        "fileName",
        "items"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the Request Excel File attachment to generate."
        },
        "items":{
            "type":"array",
            "description":"A list of items (rows) to be added to the excel file.",
            "items":{
                "$ref":"#/definitions/RequestImportFileRow"
            }
        },
        "overwrite":{
            "type":"boolean",
            "description":"If true, an existing Request attachment will be overwritten."
        }
    }
}

Nested Schema : items

Type: array

A list of items (rows) to be added to the excel file.

Show Source

• Array of: object RequestImportFileRow

{
    "type":"array",
    "description":"A list of items (rows) to be added to the excel file.",
    "items":{
        "$ref":"#/definitions/RequestImportFileRow"
    }
}

Nested Schema : RequestImportFileRow

Type: object

Show Source

• data: array data
• viewpoint: string

{
    "type":"object",
    "required":[
        "data",
        "viewpoint"
    ],
    "properties":{
        "viewpoint":{
            "type":"string"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RequestImportFileCell"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object RequestImportFileCell

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RequestImportFileCell"
    }
}

Nested Schema : RequestImportFileCell

Type: object

Show Source

• header: string
• value: string

{
    "type":"object",
    "required":[
        "header",
        "value"
    ],
    "properties":{
        "header":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Created job, generate request attachment processing

400 Response

Error in body

404 Response

Request not found

500 Response

Invalid input parameters

Back to Top

Examples

The following example shows how to Generate a request attachment by submitting a post request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X POST -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments/generate

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "fileName": "Request101.xlsx",
    "items": [
        {
            "viewpoint": "All Depts",
            "data": [
                {
                    "header": "Name",
                    "value": "New name"
                }
            ]
        }
    ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "links": [
    {
      "rel": "results",
      "href": "http://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/81ecd091-f969-4053-85ef-3718d1ad63b0"
    }
  ]
}

Back to Top