Jump to

• Request
• Response
• Examples

Create request items from a saved attachment

post

/epm/rest/v1/requests/{requestId}/import

Request

Path Parameters

• requestId(required): string(uuid)

Body ()

Root Schema : RequestImportOptionsJson

Type: object

Show Source

• attachmentUri(required): string
  URI of the attachment file to import
• sheetNames(required): array sheetNames
  List of sheets to import

{
    "type":"object",
    "required":[
        "attachmentUri",
        "sheetNames"
    ],
    "properties":{
        "sheetNames":{
            "type":"array",
            "description":"List of sheets to import",
            "items":{
                "type":"string"
            }
        },
        "attachmentUri":{
            "type":"string",
            "description":"URI of the attachment file to import"
        }
    }
}

Nested Schema : sheetNames

Type: array

List of sheets to import

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of sheets to import",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted, import processing

Body ()

Root Schema : IdNameLink

Type: object

Show Source

• description: string
  Read Only: true
• id: string(uuid)
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

404 Response

Not Found

413 Response

Request Entity Too Large

415 Response

Unsupported file media type

500 Response

Invalid file stream

Back to Top

Examples

The following example shows how to import a file attached to a request into the request 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/import

Example of Request Body

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

{
    "attachmentUri": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/e1847bbc-f2d2-46a2-af3d-2dadcf9d7bd4/attachments/b70919e7-5c07-466f-9989-6063fc59bf3e",
    "sheetNames": ["Account"]
}

Example of Response Body

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

{
  "links": [
    {
      "rel": "results",
      "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/jobRuns/c9f63edd-d2c8-4712-a1a0-43fc3a410f97"
    }
  ]
}

Back to Top