About Submitting Jobs with the Event Management API
To initiate actions for events, scenarios, and supplier invitations, such as publishing an event, you submit job requests.
For all actions except resending supplier invitations, you can retrieve event information (GET /events) to determine if the action completed.
To get all actions available for each resource (events, scenarios, and supplier invitations) and data models for request bodies, use the following endpoint:
GET /metatdata/jobs
Jobs That Act on Events
The actions you can perform on an event depend on the event state and the capabilities of the user specified in the user query parameter. These actions match the available actions in the interactive user interface.
|
To Perform This Action... |
Use This Endpoint |
|---|---|
|
Publish or republish an event (or submit an event for publishing or republishing) |
POST /jobs with "resourceType": "EVENT" and "actionName": "PUBLISH" in the body. When republishing an event, include an actionBody element in the body as defined by PublishActionJobRequest in the API specification. The actionBody specifies how any existing bids are handled and if participants are notified. |
|
Open a published event for editing (change the event state to Draft) |
POST /jobs with "resourceType": "EVENT" and "actionName": "EDIT" in the body. |
|
Revert the current draft version of an event to the previous version |
POST /jobs with "resourceType": "EVENT" and "actionName": "REVERT_DRAFT" in the body. |
|
Delete an unpublished (draft) event |
POST /jobs with "resourceType": "EVENT" and "actionName": "DELETE_DRAFT" in the body. |
|
Stop an event (close bidding and move to the Pending Selection state) |
POST /jobs with "resourceType": "EVENT" and "actionName": "STOP" in the body. |
|
Reopen an event for bidding |
POST /jobs with "resourceType": "EVENT" and "actionName": "REOPEN" in the body. To extend the event time, you can include an actionBody element in the body as defined by TimingEditJobRequest in the API specification. |
|
Pause an event |
POST /jobs with "resourceType": "EVENT" and "actionName": "PAUSE" in the body. |
|
Resume a paused event |
POST /jobs with "resourceType": "EVENT" and "actionName": "RESUME" in the body. |
|
Cancel an event. |
POST /jobs with "resourceType": "EVENT" and "actionName": "CANCEL" in the body. |
|
Undo event cancelation. |
POST /jobs with "resourceType": "EVENT" and "actionName": "UNDO_CANCEL" in the body. |
|
Extend the time for an event |
POST /jobs with "resourceType": "EVENT" and "actionName": "EXTEND_TIMING" in the body. In the body, include an actionBody element as defined by TimingEditJobRequest in the API specification to specify the new time. |
|
Reduce the time for an event |
POST /jobs with "resourceType": "EVENT" and "actionName": "REDUCE_TIMING" in the body. In the body, include an actionBody element as defined by TimingEditJobRequest in the API specification to specify the new time. |
Jobs That Act on Suppliers
The actions you can perform on suppliers depend on the event state and the capabilities of the user specified in the user query parameter. These actions match the available actions in the interactive user interface.
|
To Perform This Action... |
Use This Endpoint |
|---|---|
|
Lock suppliers (block event access) or unlock specified suppliers |
POST /jobs with "resourceType": "SUPPLIER_INVITATIONS" and "actionName": "TOGGLE_LOCK" in the body. In the request body, include an actionBody element as defined by ToggleLockJobRequest in the API specification. The actionBody specifies the suppliers that you want to lock or unlock. |
|
Resend event invitation emails to specified suppliers |
POST /jobs with "resourceType": "SUPPLIER_INVITATIONS" and "actionName": "RESEND_INVITATION_EMAIL" in the body. In the request body, include an actionBody element as defined by ResendInvitationJobRequest in the API specification. The actionBody specifies the suppliers to whom you want to resend invitations. |
Jobs That Act on Scenarios
The actions you can perform on a scenario depend on the event state, the scenario state, and the capabilities of the user specified in the user query parameter. These actions match the available actions in the interactive user interface. The response for a GET /events/{eventId}/scenarios/{scenarioId} request includes an availableActions array with the actions available for the user.
|
To Perform This Action... |
Use This Endpoint |
|---|---|
|
Copy a scenario |
POST /jobs with "resourceType": "SCENARIO" and "actionName": "COPY" in the body |
|
Optimize a scenario |
POST /jobs with "resourceType": "SCENARIO" and "actionName": "OPTIMIZE" in the body |
|
Submit a scenario for an award |
POST /jobs with "resourceType": "SCENARIO" and "actionName": "SUBMIT" in the body |
|
Delete an unpublished (draft) event |
POST /jobs with "resourceType": "EVENT" and "actionName": "DELETE_DRAFT" in the body. |
Asynchronous Job
|
To Perform This Action... |
Use This Endpoint |
|---|---|
|
Create an asynchronous CREATE_SCENARIO job |
POST /jobs with "resourceType": "SCENARIO" and "actionName": "CREATE_SCENARIO" in the body |
For additional information, refer to Retrieving Current Status of an Asynchronous Job with the Event Management API.
Additional Information and Examples
-
Publishing a new event: Creating and Publishing an Event with the Event Management API, step 6
-
Republishing a previously published event: Editing an Event with the Event Management API, step 6
-
Changing event times: Changing Event Times with the Event Management API
-
Changing event state: Changing an Event State with the Event Management API
-
Locking or unlocking suppliers: Locking (Blocking) and Unlocking Suppliers from Events with the Event Management API
-
Resending supplier invitations: Resending Supplier Invitations with the Event Management API
-
Copying a scenario: Creating Scenarios and Awards with the Event Management API, step 4
-
Optimizing a scenario: Creating Scenarios and Awards with the Event Management API, step 5
-
Submitting a scenario for award: Creating Scenarios and Awards with the Event Management API, step 6