Jump to

• Request
• Response

Get job history with pagination

get

/ccadmin/v1/cpq/products/jobs

Returns a paginated list of all CPQ product sync jobs.

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer
  Pagination limit

  Default Value: 50
• offset: integer
  Pagination offset

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the job history list.

Body ()

Root Schema : syncJobHistory_response

Type: object

Show Source

• items: array items
• limit: integer
• offset: integer
• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "limit":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/syncJob_response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object syncJob_response

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/syncJob_response"
    }
}

Nested Schema : syncJob_response

Type: object

Show Source

• endTime: string(date-time)
  End time of the job (if completed)
• jobDescription: string
  Description of the job
• jobId: string
  ID of the job
• jobName: string
  Name of the job
• startTime: string(date-time)
  Start time of the job
• status: string
  Status of the job

{
    "type":"object",
    "properties":{
        "jobName":{
            "description":"Name of the job",
            "type":"string"
        },
        "jobId":{
            "description":"ID of the job",
            "type":"string"
        },
        "jobDescription":{
            "description":"Description of the job",
            "type":"string"
        },
        "startTime":{
            "format":"date-time",
            "description":"Start time of the job",
            "type":"string"
        },
        "endTime":{
            "format":"date-time",
            "description":"End time of the job (if completed)",
            "type":"string"
        },
        "status":{
            "description":"Status of the job",
            "type":"string"
        }
    }
}

Default Response

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