Skip to content
Plainwright

Apply Templates

POST
/api/templates/apply
curl --request POST \
  --url http://localhost:8080/api/templates/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "module_id": "example", "items": [ { "key": "example", "vars": {}, "name": "example" } ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ApplyRequest
object
module_id
required
Module Id
string
items
required
Items
Array<object>
>= 1 items <= 30 items
ApplyItem
object
key
required
Key
string
vars
Vars
object
name
Any of:
string
Examplegenerated
{
  "module_id": "example",
  "items": [
    {
      "key": "example",
      "vars": {},
      "name": "example"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}