Jump to

• Request
• Response

Get a list of all recipe details

get

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

Retrieves a list of all recipes with their details. Restricted to the Intake Designer role.

Request

There are no request parameters for this operation.

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: array

Show Source

• Array of: object RecipeResponse

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

Nested Schema : RecipeResponse

Type: object

Show Source

• name: string
• recipeId: string (uuid)
• version: number

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

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

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