Jump to

• Request
• Response
• Examples

List the Export Requests

get

/iot/api/v2/exports

Returns the list of export requests. This request supports querying that allows retrieving export requests list by various filters.

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.
• limit(optional): integer
  The maximum number of entries to return to the end user.
• offset(optional): integer
  The number that the first record of results is starting from.
• q(optional): string
  Query to filter export requests (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
• since(optional): integer
  The starting point of the desired time interval, in milliseconds. The default is 0.
• totalResults(optional): boolean
  The total number of results suiting the request.
• until(optional): integer
  The finishing point of the desired time interval, in milliseconds. The default is 0.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully processed.

Body ()

Root Schema : ExportRequestImpl_receive_list

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
  The set of API navigation links.
• offset: integer(int32)

{
    "type":"object",
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "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."
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"The set of API navigation links.",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"Relation type",
                        "type":"string",
                        "example":"canonical"
                    },
                    "href":{
                        "description":"The target resource URI",
                        "type":"string",
                        "example":"https://iotserver/iot/api/vX/some/API/path"
                    }
                }
            }
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "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."
            }
        }
    }
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The set of API navigation links.",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"Relation type",
                "type":"string",
                "example":"canonical"
            },
            "href":{
                "description":"The target resource URI",
                "type":"string",
                "example":"https://iotserver/iot/api/vX/some/API/path"
            }
        }
    }
}

Nested Schema : items

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."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  The target resource URI

  Example: https://iotserver/iot/api/vX/some/API/path
• rel(optional): string
  Relation type

  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relation type",
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "description":"The target resource URI",
            "type":"string",
            "example":"https://iotserver/iot/api/vX/some/API/path"
        }
    }
}

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

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.

Back to Top

Examples

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

Example of Response Body

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

{
    "items":[
        {
            "id":"43a440de754d-268a",
            "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."
        },
        {
            "id":"21aa52103e50-23dc",
            "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."
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/iot/api/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/iot/api/version/resource/path"
        }
    ],
    "count":2,
    "limit":10,
    "offset":0,
    "hasMore":false
} 

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 

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