Orchestrator Function: VCFA Generic Rest Client

by Simon Sparks · 28 February 2026

To use this function add it to the class library file named OrchestratorPluginVCFAService.ts

GitHub Repository: https://github.com/SimonSparksUK/Orchestrator

Filename: OrchestratorPluginVCFAService.ts

Public Function: VcfaGenericRestClient

publicVcfaGenericRestClient(objVCFAHost:VCFAHost,strMethod:"GET"|"PUT"|"POST"|"DELETE"|"PATCH",strPath:string,strPayload?:string):string|null{

letblnValid:boolean=objVCFAHost.validate();

if (blnValid===true){

letobjVCFAGenericRestClient:VCFAGenericRestClient=objVCFAHost.createRestClient();

letobjVCFARestRequest:VCFARestRequest=objVCFAGenericRestClient.createRequest(strMethod,strPath,strPayload);

letobjVCFARestResponse:VCFARestResponse;

switch (strMethod){
case"GET":
objVCFARestResponse=objVCFAGenericRestClient.get(objVCFARestRequest);
case"PUT":
objVCFARestResponse=objVCFAGenericRestClient.put(objVCFARestRequest);
case"POST":
objVCFARestResponse=objVCFAGenericRestClient.post(objVCFARestRequest);
case"DELETE":
objVCFARestResponse=objVCFAGenericRestClient.delete(objVCFARestRequest);
case"PATCH":
objVCFARestResponse=objVCFAGenericRestClient.patch(objVCFARestRequest);
}

if (objVCFARestResponse.statusCode===200||objVCFARestResponse.statusCode===201){
returnobjVCFARestResponse.contentAsString;
}
else{
this.objLogger.info(`The VCFA Response Error Code was${objVCFARestResponse.statusCode} and the Error Message was${objVCFARestResponse.statusMessage}.`);

returnnull;
}
}
else{
returnnull;
}
}
TypeScript

Discover more from Cloud Build Tools

Subscribe to get the latest posts sent to your email.

You may also like