Versions Compared

Old Version 3

changes.mady.by.user Ben Hoffman

Saved on

compared with

New Version 4

changes.mady.by.user Ben Hoffman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This POST service will perform the same action found on the Release Screen.  This is used to complete a gate without having to log into the FlexDeploy server.

Info
titleAPI URL
http://host:port/flexdeploy/rest/release/completeExternalGate

...

Complete External Gate Sample JSON Request
Anchor
Full
Full


{

"authentication": { "userId":"fdadmin", "password":"password1" },

Opening bracket

Authentication section, used on all types of requests.

Required parameters for creating or editing a release.

"releaseName": "Demo Release",

"gateName": "MyExternalGate",

"snapshotName": "09-24-2017 14:26:47",

"environmentCode": "DEV",

"changeTicket": "CHG0030153",

"status": "APPROVED"

Complete the gate on the release named Demo Release

The Gate we want to complete is named "MyExternalGate".

The name of the Snapshot we want to approve is "09-24-2017 14:26:47".

The gate we're approving is in the DEV Environment.

The Change Ticket associated with the gate being approved.

The Status to give to the gate. Options are [PENDING, APPROVED, REJECTED, VOIDED]

}Closing bracket

  

Parameters

Parameter

Required

Type

Description

authentication

Y

Object

The login information for the user connecting to FlexDeploy.

releaseName

Y

String

The name of the release containing the gate we want to complete.

gateName

Y

String

The name of the gate to update the status on.

snapshotName

Y

String

The name of the executing snapshot that is waiting on the gate.

changeTicket

Y

String

The change ticket associated with this approval.

environmentCode

Y

String

The code for the environment the gate is executing in.

status

Y

String

The updated status to apply to the gate. Options are [PENDING, APPROVED, REJECTED, VOIDED]

...