Jump to

• Request
• Response

Delete a recipe configuration by recipe ID

delete

/s1-intake-svc/rest/v1.0/recipeconfig/{recipeId}

Removes unnecessary recipes configured for OCR extraction or AI prediction by passing in the relevant recipe ID in the above path. Restricted to the Intake Designer role. Note that this function deletes all the recipe configurations that include the provided recipe ID regardless of their version.

Request

Path Parameters

• recipeId(required): string(uuid)

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: string(uuid)

400 Response

Bad request

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

401 Response

Unauthorized user

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

500 Response

Internal server error

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

Back to Top