Creating an Event Within a Parent Project with the Event Management API

This procedure describes how to use the Event Management API to create an event within a parent project.

Prerequisites

Context

The POST /events endpoint of the Event Management API enables you to create a standalone event within a parent project.

Procedure

Use the POST /events endpoint with the following query parameters to create an event by copying details from an existing event:
  • selectQuickProjectTemplate: Retrieves quick project templates.

    Valid values: true and false.

  • selectGuidedSourcingTemplate: Retrieves guided sourcing templates.

    Valid values: true and false.

    Default: true.

Example:

POST {{runtime_URL}}/events?user=myUser&passwordAdapter=PasswordAdapter1&realm=mySite

To create an event, you must specify a unique event title in the request body at a minimum, for example, New Event.

If there is an entry for parentProjectId in the request body, the event will be created within a parent project. When selectGuidedSourcingTemplate is true, you must specify parentProjectId in the request body. When selectQuickProjectTemplate is false, if you delete an entry for parentProjectId from the request body, the event will be created without a parent project.

Use the following data model for the request body:

{
    "title": "New Event",
    "description": "Test",
    "templateDocumentInternalId": "Doc28806906",
    "parentProjectId": "WS28811347",
    "currency": "USD",
    "baseLanguage": "en",
    "timingMultiple": 50,
    "timingUnit": 1,
    "timingPublishType": 0,
    "eventTypeName": "RFP",
    "requester": "customersupportadmin",
    "passwordAdapter": "PasswordAdapter1",
    "isTest": false
}
					

The Event Management API returns details of the new event.

{
    {

        "title": "New Event",
        "description": "Test",
        "internalId": "Doc28814705",
        "currency": "USD",
        "status": "Draft",
        "baseLanguage": "en",
        "eventTypeName": "RFP",
        "eventStateName": "NewState",
        "owner": {
            "uniqueName": "customersupportadmin",
            "name": "Customer Support Admin",
            "isRecommended": false
        },
       ...,
        "subProject": false,
        "externalIntegrationSupported": true
    },
    "messages": [
        "Event create succeeded. "
    ]
}
					

To troubleshoot your queries to the Event Management API, refer to Error Messages Returned by the Event Management API.