Exit Enactments
/rest/api/v1.3/programs/enactments
In the case of a successful request, a success message is returned in the response body. Programs must be currently unpublished, but have been published at least once. If these requirements are not met, a 400 Bad Request error will be returned.
See the Oracle Responsys Help Center for more information about resolving blocked program stages.
Request
- application/json
object
exit-program-enactments-request
-
action(optional):
string
Allowed Values:
[ "exit" ]
Action to perform on program enactments. Must be exit. -
programName(optional):
string
Name of the program to exit enactments
Response
- application/json
Default Response
object
exit-program-enactments-response
-
errorMsg(optional):
string
Error messages when operation fails
-
status(optional):
string
Allowed Values:
[ "SUCCESS", "FAILURE" ]
SUCCESS if operation is successful otherwise FAILURE
Examples
This interface is used to move the enactments at the blocked stage out of the program. Programs must be unpublished to move enactments.
A successful request requires the following headers:
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Content-Type | application/json |
Sample Request Body:
Exit enactments out of the program named Summer_Deals.
{ "action": "exit", "programName": "Summer_Deals" }
Sample Response: Success
{ "errorMsg": null, "status": "SUCCESS" }
Example Response Failures
404 Not Found
Program not found: Requests fail when the specified program name cannot be found in Responsys. The error resembles:
{ "type": "", "title": "Program not found", "errorCode": "PROGRAM_NOT_FOUND", "detail": "Program Summer_Deals not found ", "errorDetails": [] }
400 Bad Request
Invalid action parameter: Requests fail if action is not set to exit
. The error resembles:
{ "type": "", "title": "Invalid request parameters", "errorCode": "INVALID_PARAMETER", "detail": "Request parameter 'action' should be set as 'exit'", "errorDetails": [] }
Program is published: Requests fail if the program is published. The program must be unpublished to exit enactments. The error resembles:
{ "type": "", "title": "Program is in publised state", "errorCode": "PROGRAM_IN_PUBLISED_STATE", "detail": "Summer_Deals should be unpublished before terminating", "errorDetails": [] }
Program has never been published: Requests fail if the program has never been published. Programs must be published at least once to exit enactments. The error resembles:
{ "type": "", "title": "Program is in publised state or has never been published", "errorCode": "PROGRAM_IN_INVALID_STATE", "detail": "Summer_Deals should be unpublished before terminating", "errorDetails": [] }