17.71. RPC Error Codes¶
RPC error codes are signed, 32-bit values returned by Clara Deploy SDK as part of the Standard Reponse Header.
All error codes are negative values, with non-negative values reserved for success conditions. The errors are as follows:
17.71.1. Pipeline Service Errors¶
Errors related to Pipelines and/or the Pipeline Service are in the range -[0x1000, 0x1999].
17.71.1.1. Invalid Pipeline ID¶
Returned when a Pipeline ID in an RPC request is malformed (i.e. not a valid UUID).
Code: -0x1000
17.71.1.2. Missing/Invalid Pipeline¶
Returned when specified pipeline ID does not match an existing pipeline.
Code: -0x1001
17.71.1.3. Pipeline Store Error¶
Returned when storage of a pipeline in the pipeline service fails.
Code: -0x1002
17.71.1.4. Pipeline List Error¶
Returned when listing the pipelines in the pipeline service fails.
Code: -0x1003
17.71.1.5. Pipeline Update Error¶
Returned when updating an exising pipelind in the pipeline service fails.
Code: -0x1004
17.71.1.6. Pipeline Definition Error¶
Returned when the pipeline definition in an RPC request is malformed.
Messages: An exception string describing the issue with the request.
Code: -0x1100
17.71.1.7. Pipeline Load Error¶
Returned when loading/parsing a Clara Pipeline Definition fails.
Messages: An exception string generated during the pipeline load process. This generally includes error messages to help resolve the issue with the provided pipeline definition.
Code: -0x1101
17.71.2. Jobs Service Errors¶
Errors related to Pipeline Jobs and/or the Jobs Service are in the range -[0x2000, 0x2999].
17.71.2.1. Invalid Job ID¶
Returned when a job ID in an RPC request is malformed (i.e. not a valid UUID).
Code: -0x2000
17.71.2.2. Missing/Invalid Job¶
Returned when specified job ID does not match an existing job.
Code: -0x2001
17.71.2.5. Invalid Job Name¶
Returned when the specified name of a job is invalid.
Messages: Job name parse error and/or a definition for a valid job name.
Code: -0x2100
17.71.2.6. Invalid Job Variable¶
Returned when a variable specified during job start is invalid.
Messages: Description of the variable definition that is invalid.
Code: -0x2101
17.71.2.7. Create Payload Failed¶
Returned when creating a payload as part of job creation fails.
Code: -0x2102
17.71.3. Payloads Service Errors¶
Errors related to payloads and/or the payload service are in the range -[0x3000, 0x3999].
17.71.3.1. Invalid Payload ID¶
Returned when a payload ID in an RPC request is malformed (i.e. not a valid UUID).
Code: -0x3000
17.71.3.2. Missing/Invalid Payload¶
Returned when specified payload ID does not match an existing payload.
Code: -0x3001
17.71.3.3. Missing File¶
Returned when a provided filename does not exist in the payload.
Messages: The name of the missing file.
Code: -0x3100
17.71.3.4. Delete Contents Failure¶
Returned when deleting the contents of a payload fails.
Code: -0x3101
17.71.3.5. Payload Details Failure¶
Returned when enumerating the contents of a payload fails.
Code: -0x3102
17.71.3.6. Download File Failure¶
Returned when downloading the contents of a file from a payload fails.
Messages: An exception string describing the download failure.
Code: -0x3103
17.71.3.7. Upload File Failure¶
Returned when uploading the contents of a file to a payload fails.
Messages: An exception string describing the upload failure.
Code: -0x3104