All REST Endpoints

Sort by

Task Path Method

Group by API

Intake/Intake Integration/V1

The operations from the Intake/Intake Integration/V1 category.

Ingest file(s) into the system

Method: put

Path: /s1-intake-svc/rest/v1.0/inbox/upload

Track the status of ingested document

Method: get

Path: /s1-intake-svc/rest/v1.0/integration/status

Intake/Recipe Configuration/V1

The operations from the Intake/Recipe Configuration/V1 category.

Create a new recipe configuration

Method: post

Path: /s1-intake-svc/rest/v1.0/recipeconfig

Delete a recipe configuration by recipe ID

Method: delete

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

Delete a recipe configuration by recipe ID and version

Method: delete

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

Get a list of all recipe configurations

Method: get

Path: /s1-intake-svc/rest/v1.0/recipeconfig

Get a list of all recipe details

Method: get

Path: /s1-intake-svc/rest/v1.0/recipeconfig/details

Get a recipe configuration by recipe ID

Method: get

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

Update a recipe configuration by recipe ID

Method: put

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

Recipe/Prediction Model/V1

The operations from the Recipe/Prediction Model/V1 category.

Create a new prediction model

Method: post

Path: /s1-recipe-svc/rest/v1.0/predictionmodel

Delete prediction model by model docstore ID

Method: delete

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/{predictionmodeldmsid}

Delete prediction model by model name and version

Method: delete

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/modelname/{modelname}/{modelversion}

Get a list of prediction models by model name and version

Method: put

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/getattributejson

Get All prediction models

Method: get

Path: /s1-recipe-svc/rest/v1.0/predictionmodel

Get prediction model by model docstore ID

Method: get

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/modeldmsid/{modeldmsid}

Get prediction model by model doscstore ID and version

Method: get

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/{predictionModelId}/{versionNo}

Get prediction model by model name and version

Method: get

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/modelname/{modelname}/{modelversion}

Update prediction model by model docstore ID

Method: put

Path: /s1-recipe-svc/rest/v1.0/predictionmodel/{predictionModelId}

Recipe/Recipes/V1

The operations from the Recipe/Recipes/V1 category.

Create a new recipe with valid recipe JSON

Method: post

Path: /s1-recipe-svc/rest/v1.0/recipes

Delete the latest version of recipe by recipe ID

Method: delete

Path: /s1-recipe-svc/rest/v1.0/recipes/{recipeId}

Download a file using doc ID

Method: get

Path: /s1-recipe-svc/rest/v1.0/recipes/getfilewithdocid/{docID}

Get All recipes

Method: get

Path: /s1-recipe-svc/rest/v1.0/recipes

Get All recipes by recipeId

Method: get

Path: /s1-recipe-svc/rest/v1.0/recipes/{recipeId}

Get recipe by recipe ID and version

Method: get

Path: /s1-recipe-svc/rest/v1.0/recipes/{recipeId}/{versionNo}

Get the latest version of recipe by recipe ID

Method: get

Path: /s1-recipe-svc/rest/v1.0/recipes/{recipeId}/latest

Get the list of recipes for recipe cache

Method: post

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

Update recipe by recipe ID with valid recipe JSON

Method: put

Path: /s1-recipe-svc/rest/v1.0/recipes/{recipeId}

Upload a file

Method: put

Path: /s1-recipe-svc/rest/v1.0/recipes/uploadfile/{objectName}