Jump to

• Request
• Response

Get the list of recipes for recipe cache

post

/s1-recipe-svc/rest/v1.0/recipes/cache

Retrieves a list of recipes for recipe cache based on the given RecipeRequest. Restricted to the Intake Designer role.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object RecipeRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RecipeRequest"
    }
}

Nested Schema : RecipeRequest

Type: object

Show Source

• recipeId: string (uuid)
• version: number

{
    "type":"object",
    "properties":{
        "recipeId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : RecipeInfo

Type: object

Show Source

• classificationInfo: object ClassificationInfo
• description: string
• docProcessInfo: object DocProcessInfo
• documentCategory: string
• id: string (uuid)
• intakeConfig: object IntakeConfig
• isDefaultRecipe: string
• isUnclassifyRecipe: string
• name: string
• version: number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "version":{
            "type":"number"
        },
        "description":{
            "type":"string"
        },
        "docProcessInfo":{
            "$ref":"#/components/schemas/DocProcessInfo"
        },
        "intakeConfig":{
            "$ref":"#/components/schemas/IntakeConfig"
        },
        "classificationInfo":{
            "$ref":"#/components/schemas/ClassificationInfo"
        },
        "isDefaultRecipe":{
            "type":"string"
        },
        "documentCategory":{
            "type":"string"
        },
        "isUnclassifyRecipe":{
            "type":"string"
        }
    }
}

Nested Schema : ClassificationInfo

Type: object

Show Source

• classificationId: string
• classificationTlz: integer (int64)
• subRecipes: array subRecipes
• tokenList: array tokenList

{
    "type":"object",
    "properties":{
        "classificationId":{
            "type":"string"
        },
        "subRecipes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubRecipes"
            }
        },
        "tokenList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Token"
            }
        },
        "classificationTlz":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : DocProcessInfo

Type: object

Show Source

• businessRules: array businessRules
• extractionPaths: object FieldsToExtract
• extractionTlzId: integer (int64)
• languages: array languages
• ocrTemplateStrategy: string
  Allowed Values: [ "FIRST_TEMPLATE", "MULTI_TEMPLATE", "PRIORITY_TEMPLATE", "FULL_OCR" ]
• postProcessScriptId: integer (int64)

{
    "type":"object",
    "properties":{
        "extractionTlzId":{
            "type":"integer",
            "format":"int64"
        },
        "postProcessScriptId":{
            "type":"integer",
            "format":"int64"
        },
        "businessRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ocrrules"
            }
        },
        "ocrTemplateStrategy":{
            "type":"string",
            "enum":[
                "FIRST_TEMPLATE",
                "MULTI_TEMPLATE",
                "PRIORITY_TEMPLATE",
                "FULL_OCR"
            ]
        },
        "languages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "extractionPaths":{
            "$ref":"#/components/schemas/FieldsToExtract"
        }
    }
}

Nested Schema : IntakeConfig

Type: object

Show Source

• dataStandardizationScriptId: integer (int64)
• dataValidationScriptId: integer (int64)
• modelMappingList: array modelMappingList
• ocrFieldMappingList: array ocrFieldMappingList

{
    "type":"object",
    "properties":{
        "dataStandardizationScriptId":{
            "type":"integer",
            "format":"int64"
        },
        "dataValidationScriptId":{
            "type":"integer",
            "format":"int64"
        },
        "ocrFieldMappingList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OCRFieldMapping"
            }
        },
        "modelMappingList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModelMapping"
            }
        }
    }
}

Nested Schema : subRecipes

Type: array

Show Source

• Array of: object SubRecipes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubRecipes"
    }
}

Nested Schema : tokenList

Type: array

Show Source

• Array of: object Token

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Token"
    }
}

Nested Schema : SubRecipes

Type: object

Show Source

• recipeId: string (uuid)
• recipeName: string
• recipeVersion: number
• tlzTemplateName: string

{
    "type":"object",
    "properties":{
        "recipeId":{
            "type":"string",
            "format":"uuid"
        },
        "recipeName":{
            "type":"string"
        },
        "recipeVersion":{
            "type":"number"
        },
        "tlzTemplateName":{
            "type":"string"
        }
    }
}

Nested Schema : Token

Type: object

Show Source

• featurescore: number (double)
• ngram: string

{
    "type":"object",
    "properties":{
        "featurescore":{
            "type":"number",
            "format":"double"
        },
        "ngram":{
            "type":"string"
        }
    }
}

Nested Schema : businessRules

Type: array

Show Source

• Array of: object ocrrules
  OCR Rules

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ocrrules"
    }
}

Nested Schema : FieldsToExtract

Type: object

Show Source

• details: array details

{
    "type":"object",
    "properties":{
        "details":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FieldDetails"
            }
        }
    }
}

Nested Schema : languages

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ocrrules

Type: object

OCR Rules

Show Source

• attributeName: string
• columns: string
• endLabel: string
• ruleName: string
• startLabel: string
• zoneType: string

{
    "type":"object",
    "properties":{
        "ruleName":{
            "type":"string"
        },
        "zoneType":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        },
        "startLabel":{
            "type":"string"
        },
        "endLabel":{
            "type":"string"
        },
        "columns":{
            "type":"string"
        }
    },
    "description":"OCR Rules"
}

Nested Schema : details

Type: array

Show Source

• Array of: object FieldDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FieldDetails"
    }
}

Nested Schema : FieldDetails

Type: object

Show Source

• name: string
• path: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "path":{
            "type":"string"
        }
    }
}

Nested Schema : modelMappingList

Type: array

Show Source

• Array of: object ModelMapping

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ModelMapping"
    }
}

Nested Schema : ocrFieldMappingList

Type: array

Show Source

• Array of: object OCRFieldMapping

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OCRFieldMapping"
    }
}

Nested Schema : ModelMapping

Type: object

Show Source

• friendlyName: string
• modelDataEnrichmentScriptId: integer (int64)
• modelId: string (uuid)
• modelMetadata: object ModelMetaData
• modelName: string
• modelVersion: number

{
    "type":"object",
    "properties":{
        "friendlyName":{
            "type":"string"
        },
        "modelName":{
            "type":"string"
        },
        "modelId":{
            "type":"string",
            "format":"uuid"
        },
        "modelVersion":{
            "type":"number"
        },
        "modelDataEnrichmentScriptId":{
            "type":"integer",
            "format":"int64"
        },
        "modelMetadata":{
            "$ref":"#/components/schemas/ModelMetaData"
        }
    }
}

Nested Schema : ModelMetaData

Type: object

Show Source

• modelDataEnrichmentScriptId: integer (int64)
• modelFieldMapping: array modelFieldMapping

{
    "type":"object",
    "properties":{
        "modelDataEnrichmentScriptId":{
            "type":"integer",
            "format":"int64"
        },
        "modelFieldMapping":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModelFieldMapping"
            }
        }
    }
}

Nested Schema : modelFieldMapping

Type: array

Show Source

• Array of: object ModelFieldMapping

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ModelFieldMapping"
    }
}

Nested Schema : ModelFieldMapping

Type: object

Show Source

• businessName: string
• modelFriendlyName: string

{
    "type":"object",
    "properties":{
        "businessName":{
            "type":"string"
        },
        "modelFriendlyName":{
            "type":"string"
        }
    }
}

Nested Schema : OCRFieldMapping

Type: object

Show Source

• businessName: string
• friendlyName: string

{
    "type":"object",
    "properties":{
        "businessName":{
            "type":"string"
        },
        "friendlyName":{
            "type":"string"
        }
    }
}

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

404 Response

Recipe not found

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