Configure manual sign-offs

Learn how to use the CI/CD Manager API to configure your manual sign-offs.

Note:

For details on manual sign-offs, see Manual sign-offs in the Cloud Platform documentation.

All sample requests in this guide include the following path parameters:

Parameter name	Description
tenantId	Tenant ID.
starSystemId	ID of the star that includes the InsuranceSuite application for which you configure quality gates.
applicationId	InsuranceSuite application which includes the build. For example: - PC for PolicyCenter - BC for BillingCenter - CC for ClaimCenter - CM for ContactManager
qualityGateID	ID of a quality gate.

Create a manual sign-off

To create a manual sign-off, send the following POST request:

curl -X 'POST' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'
    -d '{body}'

Where {body} is a JSON object that represents a quality gate:

Example request body

{
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "templateSettings": {
    "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
    "templateParameters": {
      "approvers": ["user@guidewire.com"]
    }
  },
  "description": "This quality gate verifies that a user manually approved a build for promotion to the pre-production star system."
}

You can add a maximum of ten approvers.

A response body contains a JSON object representing the newly created quality gate:

Example response body

{
  "id": "af7f32f1-fa93-4379-b6e9-177ddfdb5a68",
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "name": null,
  "description": "This quality gate verifies that a user manually approved a build for promotion to the pre-production star system.",
  "testMetadata": null,
  "branchFilter": null,
  "templateSettings": {
    "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
    "templateParameters": {
      "approvers": ["user@guidewire.com"]
    }
  }
}

Get a list of all the quality gates configured for a given stage

To list the already existing manual sign-offs for a given stage, send the following GET request:

curl -X 'GET' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates?stage={STAGE}&templateType=MANUAL_SIGN_OFF_QUALITY_GATE
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'

Where STAGE represents one of the following stages at which the manual sign-off can apply:

• PRE_PROMOTION_PREPROD
• PRE_PROMOTION_PROD

A response body contains a JSON object with a list of all the existing manual sign-offs. For example, a request to list all the PRE_PROMOTION_PREPROD manual sign-offs might get the following response:

Example response body

[
  {
    "id": "539e5d19-7922-43ce-80e2-fb96c45ab6b4",
    "stage": "PRE_PROMOTION_PREPROD",
    "required": true,
    "name": null,
    "description": "This quality gate verifies that a user manually approved a build for promotion to the pre-production star system.",
    "testMetadata": null,
    "branchFilter": null,
    "templateSettings": {
      "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
      "templateParameters": {
        "approvers": ["user1@guidewire.com"]
      }
    }
  },
  {
    "id": "862d4747-b966-4528-b419-f0dca3d1495f",
    "stage": "PRE_PROMOTION_PREPROD",
    "required": false,
    "name": null,
    "description": null,
    "testMetadata": null,
    "branchFilter": null,
    "templateSettings": {
      "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
      "templateParameters": {
        "approvers": ["user2@guidewire.com"]
      }
    }
  }
]

Update a manual sign-off

To update a manual sign-off, send the following PUT request:

curl -X 'PUT' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates/{qualityGateId}
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'
    -d '{body}'

Where {body} is a JSON object that represents an updated manual sign-off:

Example request body

{
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "templateSettings": {
    "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
    "templateParameters": {
      "approvers": ["user@guidewire.com"]
    }
  },
  "description": "This quality gate verifies that a user manually approved a build for promotion to the pre-production star system."
}

You can modify only the following parameters:

• required
• description
• approvers (inside templateParameters)

A response body contains a JSON object representing the updated manual sign-off:

Example response body

{
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "name": null,
  "description": "This updated quality gate verifies that a user manually approved a build for promotion to the pre-production star system.",
  "testMetadata": null,
  "branchFilter": null,
  "templateSettings": {
    "templateType": "MANUAL_SIGN_OFF_QUALITY_GATE",
    "templateParameters": {
      "approvers": ["user@guidewire.com"]
    }
  }
}

Delete a manual sign-off

To delete a manual sign-off that you no longer need, send the following DELETE request without any request body:

curl -X 'DELETE' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates/{qualityGateId}
    -H 'Authorization: Bearer {access_token}'

You'll receive a response with HTTP code 204 and without any response body.