Approve Service Catalog

Prev Next

You can create SRs along with the Approval using the following API Request. 

Service Name

HTTP Method

SR_ApproveServiceCatalog_Workflow

POST

Sample Request

{
 "ServiceName":"SR_ApproveServiceCatalog_Workflow",
   "objCommonParameters":{      
      "_ProxyDetails":{
       "AuthType": "APIKEY",
        "APIKey": "XXXXXXXXXXXXXXXXX",
         "ProxyID":0,
         "ReturnType":"JSON"       
      },    
         "objSRServiceTicket":{"UserId":"229","CurrentLevelApprovers":"","TicketID":134,"SupportFunction":"IT","WorkgroupID":1,"ServiceTicketID":134,"ApprovalDelegatedId":0,"ApprovalRemarks":"Approving SR for the testing purpose,please ignore","Status":"true","CurrentApprovalLevel":"1","Org_ID":"1","ServiceCatalogID":31,"HasCompleteApprovalFlow":0,"ServiceCategoryID":1,"ForwardUserId":0,"ListSRApprovals":[],"DelegationMode":0,
"strCustomAttributes":"[{\"Attribute_ID\":387,\"Attribute_Name\":\"Pickup align date\",\"Attribute_Value\":\"2021-01-08\",\"Attribute_Type\":\"Date\"},{\"Attribute_ID\":\"388\",\"Attribute_Name\":\"Transporter\",\"Attribute_Value\":\"398\",\"Attribute_Type\":\"DropdownList\"}]"
                    
               }
   }
} 

Request Parameters

Parameter Name

Type

Description

Mandatory

Service Name

STRING

The name of the static service (SR_ApproveServiceCatalog_Workflow).

FALSE

APIKey

STRING

APIKey that is generated that is described in API Authentication and Authorization section.

Value should be APIKey.

FALSE

AuthType

STRING

Type of Authentication.

FALSE

ProxyID

INTEGER

Type of the request return.

The value should be 0.

FALSE

ReturnType

STRING

Type of the request return.

For Example: Json, XML, YAML, etc.

FALSE


OrgID

INTEGER

Unique Identification of the Organization.

The value should be 1. 

FALSE


UserID

INTEGER

Unique Identification of the user. It is a approver User ID.

TRUE

TicketID

INTEGER

Identification number of the ticket.

FALSE

SupportFunction

STRING

Type the support function information. For example:  IT.

FALSE

WorkgroupID

INTEGER

Identification number of the Workgroup for which the required Service Request belong to.

FALSE

ServiceTicketID

INTEGER

Unique identification number of the Service ticket number.

TRUE

Status

STRING

The status of the service catalog. If input value is “True” then it is Approved and If input value is “False” then it is rejected.

TRUE

CurrentApprovedLevel

INTEGER

The level of the current approval. The Level of Approver could be 1,2,3 and so on.

TRUE

ServiceCatalogID

INTEGER

Unique Identification number of the Service Catalog. 

If the Service Catalog has mandatory Custom Attributes, the strCustomAttributes parameter is mandatory.

TRUE

ServiceCategoryID

INTEGER

Unique Identification number of the Service Category.

Note:

It is mandatory to provide either ServiceCategoryID or ServiceCategoryName value.

FALSE

strCustomAttributes

ARRAY

Custom attributes for a specified User. These Custom Fields include the following parameters: 

  • Attribute_ID

  • Attribute_Name

  • Attribute_Value

  • Attribute_Type

FALSE

Sample Request

{
 "ServiceName":"SR_ApproveServiceCatalog_Workflow",
   "objCommonParameters":{      
      "_ProxyDetails":{
       "AuthType": "APIKEY",
        "APIKey": "XXXXXXXXXXXXXXXXX",
         "ProxyID":0,
         "ReturnType":"JSON"       
      }    
         "objSRServiceTicket":{"UserId":"229","CurrentLevelApprovers":"","TicketID":134,"SupportFunction":"IT","WorkgroupID":1,"ServiceTicketID":134,"ApprovalDelegatedId":0,"ApprovalRemarks":"Approving SR for the testing purpose,please ignore","Status":"true","CurrentApprovalLevel":"1","Org_ID":"1","ServiceCatalogID":31,"HasCompleteApprovalFlow":0,"ServiceCategoryID":1,"ForwardUserId":0,"ListSRApprovals":[],"DelegationMode":0
                   
               }
   }
} 

Request Parameters

Parameter Name

Type

Description

Mandatory

Service Name

STRING

The name of the static service 
(SR_ApproveServiceCatalog_Workflow).

FALSE

APIKey

STRING

APIKey that is generated that is described in API Authentication and Authorization section.
Value should be APIKey.

FALSE

AuthType

STRING

Type of Authentication. 

FALSE


ProxyID

INTEGER

Type of the request return.

The value should be 0.

FALSE

ReturnType

STRING

Type of the request return.

For Example: Json, XML, YAML, etc.

FALSE


OrgID

INTEGER

Unique Identification of the Organization.

The value should be 1. 

FALSE

UserID

INTEGER

Unique Identification of the user. It is a approver User ID.

TRUE

TicketID

INTEGER

Identification number of the ticket.

FALSE

SupportFunction

STRING

Type the support function information. For example:  IT.

TRUE

WorkgroupID

INTEGER

Identification number of the Workgroup for which the required Service Request belong to.

FALSE

ServiceTicketID

INTEGER

Unique identification number of the Service ticket number.

TRUE

Status

STRING

The status of the service catalog. If input value is “True” then it is Approved and If input value is “False” then it is rejected.

TRUE

CurrentApprovalLevel

INTEGER

The level of the current approval. The Level of Approver could be 1,2,3 and so on.

TRUE

ServiceCatalogID

INTEGER

Unique Identification number of the Service Catalog. 

If the Service Catalog has mandatory Custom Attributes, the strCustomAttributes parameter is mandatory.

FALSE

ServiceCategoryID

INTEGER

Unique Identification number of the Service Category.

Note:

It is mandatory to provide either ServiceCategoryID or ServiceCategoryName value.

FALSE