Jump to

• Request
• Response
• Examples

Retrieve the Details of an Export Request

get

/iot/api/v2/exports/{request-id}

Returns the export request by specified ID.

Request

Path Parameters

• request-id: string
  ID of the export request

Query Parameters

• expand(optional): string
  The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
• fields(optional): string
  The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully processed.

Body ()

Root Schema : ExportRequestImpl_receive

Type: object

Show Source

• completed: integer
  Date of the request completion in milliseconds since January 1, 1970
• completedAsString: string
  Date of the request completion represented as ISO string.
• created: integer
  Date of the request creation in milliseconds since January 1, 1970
• createdAsString: string
  Date of the request creation represented as ISO string.
• createdBy: string
  Name of the user who created this request.
• description: string
  Export request description.
• fileName: string
  The file name which is associated with this request.
• id: string
  Unique identifier that identifies the export request.
• status: string
  The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED].

{
    "type":"object",
    "required":[
        "id",
        "status",
        "description",
        "fileName",
        "createdBy",
        "created",
        "createdAsString",
        "completed",
        "completedAsString"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that identifies the export request."
        },
        "status":{
            "type":"string",
            "description":"The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED]."
        },
        "description":{
            "type":"string",
            "description":"Export request description."
        },
        "fileName":{
            "type":"string",
            "description":"The file name which is associated with this request."
        },
        "createdBy":{
            "type":"string",
            "description":"Name of the user who created this request."
        },
        "created":{
            "type":"integer",
            "description":"Date of the request creation in milliseconds since January 1, 1970"
        },
        "createdAsString":{
            "type":"string",
            "description":"Date of the request creation represented as ISO string."
        },
        "completed":{
            "type":"integer",
            "description":"Date of the request completion in milliseconds since January 1, 1970"
        },
        "completedAsString":{
            "type":"string",
            "description":"Date of the request completion represented as ISO string."
        }
    }
}

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/iot/api/v2/exports/{request-id} 

Example of Response Body

The following example shows the content of the response body in JSON format:

{
    "id":"3b3859ca314a-6380",
    "status":"The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED].",
    "description":"Export request description.",
    "fileName":"The file name which is associated with this request.",
    "createdBy":"Name of the user who created this request.",
    "created":1469184297746,
    "createdAsString":"2016-07-22T10:44:57.746Z",
    "completed":12345,
    "completedAsString":"Date of the request completion represented as ISO string."
} 

Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/iot/api/v2/exports/5159473b696e-7e5b 

Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.

Back to Top