FIfieldguide
engagements

Create a new Engagement from a template

Changed on

Creates a new Engagement based on an existing template Engagement. The request is accepted for asynchronous processing; the response returns the new Engagement's UUID and the Job UUID used to poll its provisioning status.

post/v1/engagements/from-template

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/engagements/from-template
  • Auth
    HTTP bearer

Request body

template_uuidstring uuid required
client_company_uuidstring uuid required
template_version_uuidstring uuid

Which member of the template's version family to create the Engagement from, identified by its Engagement Template UUID. Must belong to the same version family as "template_uuid" and be available for new Engagements. The template's working draft may only be named while the family has no saved version available for new Engagements. Omit it to use the newest saved version the firm has made available, falling back to the working draft when the family has none.

namestring required
start_datestring
end_datestring
report_issue_datestring
identifierstring nullable

An external identifier that can be used by integrated systems

Example request

{
  "template_uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
  "client_company_uuid": "022723f4-1d6a-4c6c-9387-f63c7d66f0fc",
  "template_version_uuid": "d2c9b0a4-6f1e-4f2b-9a7e-7c4f2b1d8e50",
  "name": "SOC 2 - Type 1",
  "start_date": "2023-07-30",
  "end_date": "2023-07-30",
  "report_issue_date": "2023-07-30",
  "identifier": "E0001-A"
}

Response

The Engagement creation has been accepted for processing

Example response

{
  "data": {
    "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "job_uuid": "2d2e102e-f4af-4534-9749-4d9249eca6cc",
    "_links": {
      "status": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}

Changes