Jump to

• Request
• Response
• Examples

List files in the staging area

get

/epm/rest/v1/files/staging

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

successful operation

Body ()

Root Schema : ItemsStagingFile

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
• items(optional): array items
  Read Only: true
• limit(optional): integer(int32)
• links(optional): array links
  Read Only: true
• offset(optional): integer(int32)
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/FileMetadata"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object FileMetadata
  File Information

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/FileMetadata"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : FileMetadata

Type: object

File Information

Show Source

• created(optional): integer(int64)
  Creation time of the file.
• fileName(optional): string
  Name of the file.
• links(optional): array links
• size(optional): integer(int64)
  Size of the file.

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"Name of the file."
        },
        "created":{
            "type":"integer",
            "format":"int64",
            "description":"Creation time of the file."
        },
        "size":{
            "type":"integer",
            "format":"int64",
            "description":"Size of the file."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"File Information"
}

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(optional): string
• method(optional): string
• rel(optional): string
• templated(optional): boolean

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

403 Response

Forbidden

500 Response

Cannot list files in staging area.

Back to Top

Examples

The following example shows how to List files in staging area by submitting a get request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET \
  https://servername.fa.us2.oraclecloud.com/epm/rest/v1/files/staging -O

Back to Top