Jump to

• Request
• Response

listExportOperations

get

/ccadmin/v1/exportOperations

List Export Operations. Retrieves all export operations

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listExportOperations_response

Type: object

Show Source

• items: array items
  List of all export operation objects.

{
    "properties":{
        "items":{
            "description":"List of all export operation objects.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "formats":{
                        "description":"Export data formats",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "typeName":{
                        "description":"Export data type name",
                        "type":"string"
                    },
                    "formatNames":{
                        "description":"Export data format names",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "typeId":{
                        "description":"Export data type",
                        "type":"string"
                    },
                    "id":{
                        "description":"Export operation id",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of all export operation objects.

Show Source

• Array of: object items

{
    "description":"List of all export operation objects.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "formats":{
                "description":"Export data formats",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "typeName":{
                "description":"Export data type name",
                "type":"string"
            },
            "formatNames":{
                "description":"Export data format names",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "typeId":{
                "description":"Export data type",
                "type":"string"
            },
            "id":{
                "description":"Export operation id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• formatNames: array formatNames
  Export data format names
• formats: array formats
  Export data formats
• id: string
  Export operation id
• typeId: string
  Export data type
• typeName: string
  Export data type name

{
    "type":"object",
    "properties":{
        "formats":{
            "description":"Export data formats",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "typeName":{
            "description":"Export data type name",
            "type":"string"
        },
        "formatNames":{
            "description":"Export data format names",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "typeId":{
            "description":"Export data type",
            "type":"string"
        },
        "id":{
            "description":"Export operation id",
            "type":"string"
        }
    }
}

Nested Schema : formatNames

Type: array

Export data format names

Show Source

• Array of: string

{
    "description":"Export data format names",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : formats

Type: array

Export data formats

Show Source

• Array of: string

{
    "description":"Export data formats",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "items":[
        {
            "formats":[
                "json",
                "csv"
            ],
            "typeName":"Profiles",
            "formatNames":[
                "JSON Format",
                "CSV Format"
            ],
            "typeId":"Profiles",
            "id":"Profiles"
        },
        {
            "formats":[
                "json",
                "csv"
            ],
            "typeName":"Accounts",
            "formatNames":[
                "JSON Format",
                "CSV Format"
            ],
            "typeId":"Accounts",
            "id":"Accounts"
        }
    ]
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top