Responses

201 Created

The model was successfully added

Content-Type application/vnd.com.fico.executor.v2+json

Empty response body

FICO-Execution-Host	The hostname of the Executor that handled the request	string

403 Forbidden

The component is not in the design lifecycle environment

Content-Type application/vnd.com.fico.executor.v2+json

Empty response body

FICO-Execution-Host	The hostname of the Executor that handled the request	string

413 Request Entity Too Large

The model file size exceeded the maximum model upload file size (xpress.executor.max-upload-size)

Content-Type application/vnd.com.fico.executor.v2+json

ErrorResponse

Example:

{
    "error": {
        "code": "FICO-Platform-Http-413",
        "desc": "Payload Too Large",
        "innerError": {
            "code": "FICO-Platform-Validation-FileTooLarge",
            "desc": "Model file too large",
            "message": "Unzipped file exceeded upload threshold (900 MB)."
        },
        "message": "Payload Too Large",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

Example:

{
    "error": {
        "code": "FICO-Platform-Http-413",
        "desc": "Payload Too Large",
        "innerError": {
            "code": "FICO-Platform-Validation-FileTooLarge",
            "desc": "Too many files in model zip",
            "message": "Model zip must not have more than a thousand files."
        },
        "message": "Payload Too Large",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

Example:

{
    "error": {
        "code": "FICO-Platform-Http-413",
        "desc": "Payload Too Large",
        "innerError": {
            "code": "FICO-Platform-Validation-FileTooLarge",
            "desc": "Model file too large",
            "message": "File exceeded upload threshold (300 MB)."
        },
        "message": "Payload Too Large",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

FICO-Execution-Host	The hostname of the Executor that handled the request	string

422 Unprocessable Entity

The file was invalid. See the details in the error response.

Content-Type application/vnd.com.fico.executor.v2+json

ErrorResponse

Example:

{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Missing BIM file",
            "message": "The compiled model file was not found at the top level of the archive."
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

Example:

{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Model upload failure",
            "message": "Failed to import model."
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

Example:

{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Model zip file invalid",
            "message": "Failed to import model: File is not a valid zip archive."
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

Example:

{
    "error": {
        "code": "FICO-Platform-Http-422",
        "desc": "Unprocessable Entity",
        "innerError": {
            "code": "FICO-Platform-Validation-InvalidValue",
            "desc": "Unparsable BIM file",
            "message": "Failed to parse the model.bim file."
        },
        "message": "Unprocessable Entity",
        "parentId": "0000000000000def",
        "spanId": "0000000000000123",
        "timestamp": "1970-01-03T02:01:33.219Z",
        "traceId": "0000000000000abc"
    }
}

FICO-Execution-Host	The hostname of the Executor that handled the request	string