Jump to

• Request
• Response

getExportProcess

get

/ccadmin/v1/exportProcess/{token}

Get Export Process. Get the status resource of an export process.

Request

Supported Media Types

• application/json

Path Parameters

• token(required): string
  Token corresponding to the export process.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getExportProcess_response

Type: object

Show Source

• completed: boolean
  Flag indicating whether process is completed or not.
• completedPercentage: integer
  The percentage of the process completed.
• endTime: string
  Time when the process finished.
• error: object error
  Error detail of the original request.
• links: array links
• progress: string
  Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  The current progress of the process.
• requestStatus: integer
  HTTP status code of the original request.
• startTime: string
  Time when the process started.

{
    "properties":{
        "completedPercentage":{
            "description":"The percentage of the process completed.",
            "type":"integer"
        },
        "progress":{
            "description":"The current progress of the process.",
            "type":"string",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "startTime":{
            "description":"Time when the process started.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"It specifies that this url is related or referring to status of job(meta), file or self",
                        "type":"string"
                    },
                    "href":{
                        "description":"Url link to status of job(meta) or self",
                        "type":"string"
                    }
                }
            }
        },
        "endTime":{
            "description":"Time when the process finished.",
            "type":"string"
        },
        "completed":{
            "description":"Flag indicating whether process is completed or not.",
            "type":"boolean"
        },
        "error":{
            "description":"Error detail of the original request.",
            "type":"object",
            "properties":{
                "detail":{
                    "description":"Description of the problem.",
                    "type":"string"
                },
                "type":{
                    "description":"Absolute URI that identifies the problem type.",
                    "type":"string"
                },
                "title":{
                    "description":"Short summary of the problem.",
                    "type":"string"
                }
            }
        },
        "requestStatus":{
            "description":"HTTP status code of the original request.",
            "type":"integer"
        }
    }
}

Nested Schema : error

Type: object

Error detail of the original request.

Show Source

• detail: string
  Description of the problem.
• title: string
  Short summary of the problem.
• type: string
  Absolute URI that identifies the problem type.

{
    "description":"Error detail of the original request.",
    "type":"object",
    "properties":{
        "detail":{
            "description":"Description of the problem.",
            "type":"string"
        },
        "type":{
            "description":"Absolute URI that identifies the problem type.",
            "type":"string"
        },
        "title":{
            "description":"Short summary of the problem.",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"It specifies that this url is related or referring to status of job(meta), file or self",
                "type":"string"
            },
            "href":{
                "description":"Url link to status of job(meta) or self",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
  Url link to status of job(meta) or self
• rel: string
  It specifies that this url is related or referring to status of job(meta), file or self

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"It specifies that this url is related or referring to status of job(meta), file or self",
            "type":"string"
        },
        "href":{
            "description":"Url link to status of job(meta) or self",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "completedPercentage":100,
    "progress":"succeeded",
    "startTime":"2016-04-04T20:25:01.982Z",
    "links":[
        {
            "rel":"meta",
            "href":"http://example.com:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportStatus.zip"
        },
        {
            "rel":"file",
            "href":"http://example.com:9080/file/export/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000/exportProfilesAndOrders.zip"
        },
        {
            "rel":"self",
            "href":"http://example.com:9080/ccadminui/v1/exportProcess/ezzPxcPRmJIlXYCyOTQNT9HMacA_10000"
        }
    ],
    "endTime":"2016-04-04T20:25:02.190Z",
    "completed":true,
    "requestStatus":200
}

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