Get Event by ID

API Type

REST

HTTP Method

GET

Description

Retrieves an event object.

Good to Know

  • This method is usually used to check if a service call has been completed.

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Workflow/GetEvent/[eventID]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/GetEvent/[eventID]

Request Parameters

Name Description

eventID
Function:
Specifies a unique ID for an event.
Type
string
Accepted Values:
A unique, 32-character ID.

JavaScript Code Example

$("#btnGetEvent").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetEvent/0001D1C507B0451082ECC56BB49713BB",
    type: "GET"
  });
  
});

Java Code Example

public String GetEvent() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        GetEvent/0001D1C507B0451082ECC56BB49713BB";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  return ops.GETMethod(URI);
}

C# Code Example

public string GetEvent()
  {
          
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         GetEvent/0001D1C507B0451082ECC56BB49713BB";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.GetData(URI);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl -H "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         GetEvent/827028D244B4F4D9117760A414427E9C

Output

WFEvent object.

JSON Response Body Example

{
  "GetEventResult":
  {
    "ActivityInstID":"",
    "AutoStart":true,
    "CustomAttributes":null,
    "Diagnostic":true,
    "EndDate":" \/Date(928149600000)\/",
    "Entries":0,"Error":null,
    "EventID":"0001D1C507B0451082ECC56BB49713BB",
    "EventName":"CreateProcessInstance",
    "HighPriority":false,
    "ParamsXml":"<?xml version=\"1.0\" encoding=\"utf-8\"?>
                 <WFEvent>
                 <param name=\"UserID\" value=\"2AD8B7B4C9DF0198087CF50D0DDE
                                              7431DF67FBE7D0123CAF969E31FE
                                              3C85EE12A1F8F19DDA75A5FF79124
                                              BA90DB2311A28DEE43490FCC1B68A7
                                              CDD5F50E04BF5 42D0F384820A03BBED
                                              C2CD2D2F3E14B9A35F7774812C53B63E
                                              A655C2A840B54CC383EA81EB10BF8AE0
                                              3CD920A20ECA79\" \/>
                 <param name=\"AutoStart\" value=\"True\" \/>
                 <param name=\"WorkObjectID\" value=\"AAF1FE3CEEBD410BA
                                                      2D30745ACB95DAA\" \/>
                 <param name=\"ProcInstID\" value=\"10B50DDB36A04E66A6
                                                      277CE0C72688EC\" \/>
                 <param name=\"ProcInstName\" value=\"AgileFormMobileApp-
                                                     7F33E38BC8E945D6B3ED
                                                     59B666C6ACAD\" \/>
                 <param name=\"ProcDefID\" value=\"9A901F728F124055
                                                   A8759AAB0A97E966\" \/>
                 <param name=\"ClientData\" value=\"AAF1FE3CEEBD410
                                                     BA2D30745ACB95DAA\" \/>
                 <\/WFEvent>",

    "ParentProcInstID":"",
    "ProcDefID":"9A901F728F124055A8759AAB0A97E966",
    "ProcInstID":"10B50DDB36A04E66A6277CE0C72688EC",
    "ProcInstName":" mycompany MobileApp-7F33E38BC8E945D6B3ED59B666C6ACAD",
    "Sender":"mydomain\\Administrator",
    "SentDate":" \/Date(928149600000)\/",
    "SourceWorkItemID":"",
    "Status":"Processed",
    "TenantID":null,
    "UserID":"2AD8B7B4C9DF0198087CF50D0
              DDE7431DF67FBE7D0123CAF96
              9E31FE3C85EE12A1F8F19DDA7
              5A5FF79124BA90DB2311A28DE
              E43490FCC1B68A7CDD5F50E04BF5 
              42D0F384820A03BBEDC2CD2D2F3E
              14B9A35F7774812C53B63EA655C2
              A840B54CC383EA81EB10BF8AE03C
              D920A20ECA79",
    "WorkItemID":"",
    "WorkObjectID":"AAF1FE3CEEBD410BA2D30745ACB95DAA",
    "WorkObjectInfo":""
  }
}

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.