Fetch a Program by Name
get
/rest/api/v1.3/programs/{programName}
Fetches a Program by program name.
Request
Supported Media Types
- application/x-www-form-urlencoded
Path Parameters
-
programName: string
Name of the Program to fetch the details
Response
Supported Media Types
- application/json
Default Response
Fetches details for the specified program name.
Root Schema : programByName-response
Type:
object
Title:
Show Source
programByName-response
-
channels:
array channels
List of channels for the program
-
createdBy:
string
User that created the program
-
createdOn:
string
Creation date of the program
-
folderName:
string
Folder name for the program.
-
id:
string
ID of the program.
-
links:
object links
link URLs that represents next link table APIs
-
list:
object list
List details associated with the program
-
modifiedBy:
string
User that last modified the program
-
modifiedOn:
string
Last Modified date of the program
-
name:
string
Name of the program.
-
publishDate:
string
Last Publish date of the program
-
status:
string
Allowed Values:
[ "RUNNING", "NOT_RUNNING", "RUNNING_WITH_ERRORS" ]
Status of the program -
unpublishDate(optional):
string
Unpublish date of the program. It is not displayed for a program in running state
Nested Schema : links
Type:
object
link URLs that represents next link table APIs
Show Source
-
href(optional):
string
URI of link table API
-
method(optional):
string
request method type
-
rel(optional):
string
link table API name
Nested Schema : list
Type:
object
List details associated with the program
Show Source
-
id:
string
listId
-
name:
string
listname
Examples
Use this interface to get a list of Responsys programs, using the program name to search. The response includes information about the program.
Required request headers:
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Content-Type | application/json |
Response Notes:
Sample Response Body
{ "id": 86292841, "name": "Program_Name", "folderName": "API_Folder", "channels": [ ], "list": { "id": 86126161, "name": "List_Name" }, "status": "NOT_RUNNING", "createdOn": "13/05/2020", "createdBy": "API_Account", "modifiedOn": "13/05/2020", "modifiedBy": "API_Account", "links": [ { "rel": "self", "href": "/rest/api/v1.3/programs/Program_Name", "method": "GET" }, { "rel": "getAllPrograms", "href": "/rest/api/v1.3/programs", "method": "GET" }, { "rel": "updateProgramState", "href": "/rest/api/v1.3/programs/Program_Name", "method": "PATCH" } ] }