Retrieves An approval policy.

Retrieves An approval policy.

Retrieves an approval policy

Request
URI
GET
https://{api_host}/approval-service/api/policies/{id}
COPY
Path Parameters
string
id
Required

The approval policy id

Responses
200

successful operation

Returns ApprovalPolicy of type(s) */* 
{
    "lastModifiedBy": "string",
    "description": "string",
    "version": 0,
    "createdDate": "string",
    "approvableItemId": "string",
    "typeFilter": "string",
    "stateName": "string",
    "createdBy": "string",
    "policyType": {
        "phaseTypes": [
            {
                "phaseOrder": 0,
                "name": "string",
                "description": "string",
                "id": "string",
                "forms": {},
                "allowUpdates": false
            }
        ],
        "classId": "string",
        "typeFilter": "string",
        "name": "string",
        "description": "string",
        "serviceTypeId": "string",
        "id": "string"
    },
    "name": "string",
    "id": "string",
    "state": "string",
    "lastModified": "string",
    "approvableItemName": "string",
    "approvableItemServiceTypeId": "string",
    "phases": [
        {
            "name": "string",
            "description": "string",
            "id": "string",
            "levels": [
                {
                    "approvalMode": "string",
                    "external": false,
                    "editSchema": {
                        "fields": [
                            {}
                        ]
                    },
                    "name": "string",
                    "levelNumber": 0,
                    "description": "string",
                    "approvers": [
                        {
                            "displayName": "string",
                            "type": "string",
                            "value": "string"
                        }
                    ],
                    "id": "string"
                }
            ],
            "phasetype": {
                "phaseOrder": 0,
                "name": "string",
                "description": "string",
                "id": "string",
                "forms": {},
                "allowUpdates": false
            }
        }
    ]
}
string
lastModifiedBy
Optional

lastModifiedBy

string
description
Optional

description

integer As int64 As int64
version
Optional

version

string As date-time As date-time
createdDate
Optional

createdDate

string
approvableItemId
Optional

approvableItemId

string
typeFilter
Optional

typeFilter

string
stateName
Optional

stateName

string
createdBy
Optional

createdBy

ApprovalPolicyType
policyType
Required

policyType

string
name
Required

name

string As uuid As uuid
id
Optional

id

string
state
Required

state

Possible values are : DRAFT, PUBLISHED, RETIRED,
string As date-time As date-time
lastModified
Optional

lastModified

string
approvableItemName
Optional

approvableItemName

string
approvableItemServiceTypeId
Optional

approvableItemServiceTypeId

array of Phase
phases
Required

phases


On This Page
Approval Policy Operations
POST
Creates A new approval policy.
DELETE
Deletes An approval policy.
GET
Lists the approval policies.
GET
Retrieve A form.
POST
Retrieves A paged list Of permissible values that can Be assigned To A specific field.
GET
Retrieves An approval policy.
POST
Retrieves the updated state Of one Or more layout elements In response To change In one Or more layout fields' values.
PUT
Updates An Approval Policy while ignoring few Of the validations. This Is An internal API which Is used for upgrade.
PUT
Updates An approval policy.