Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

Fetches details for the specified program name.

Body ()

Root Schema : programByName-response

Type: object

Title: programByName-response

Show Source

• 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

{
    "type":"object",
    "title":"programByName-response",
    "properties":{
        "id":{
            "description":"ID of the program.",
            "type":"string"
        },
        "name":{
            "description":"Name of the program.",
            "type":"string"
        },
        "folderName":{
            "description":"Folder name for the program.",
            "type":"string"
        },
        "channels":{
            "description":"List of channels for the program",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "list":{
            "description":"List details associated with the program",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"listId"
                },
                "name":{
                    "type":"string",
                    "description":"listname"
                }
            },
            "required":[
                "id",
                "name"
            ]
        },
        "status":{
            "description":"Status of the program",
            "enum":[
                "RUNNING",
                "NOT_RUNNING",
                "RUNNING_WITH_ERRORS"
            ],
            "type":"string"
        },
        "createdOn":{
            "description":"Creation date of the program",
            "type":"string"
        },
        "createdBy":{
            "description":"User that created the program",
            "type":"string"
        },
        "modifiedOn":{
            "description":"Last Modified date of the program",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User that last modified the program",
            "type":"string"
        },
        "publishDate":{
            "description":"Last Publish date of the program",
            "type":"string"
        },
        "unpublishDate":{
            "description":"Unpublish date of the program. It is not displayed for a program in running state",
            "type":"string"
        },
        "links":{
            "type":"object",
            "description":"link URLs that represents next link table APIs",
            "properties":{
                "rel":{
                    "type":"string",
                    "description":"link table API name"
                },
                "href":{
                    "type":"string",
                    "description":"URI of link table API"
                },
                "method":{
                    "type":"string",
                    "description":"request method type"
                }
            }
        }
    },
    "required":[
        "id",
        "links",
        "name",
        "folderName",
        "channels",
        "list",
        "status",
        "createdOn",
        "createdBy",
        "modifiedOn",
        "modifiedBy",
        "publishDate"
    ]
}

Nested Schema : channels

Type: array

List of channels for the program

Show Source

• Array of: string

{
    "description":"List of channels for the program",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

{
    "type":"object",
    "description":"link URLs that represents next link table APIs",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link table API name"
        },
        "href":{
            "type":"string",
            "description":"URI of link table API"
        },
        "method":{
            "type":"string",
            "description":"request method type"
        }
    }
}

Nested Schema : list

Type: object

List details associated with the program

Show Source

• id: string
  listId
• name: string
  listname

{
    "description":"List details associated with the program",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"listId"
        },
        "name":{
            "type":"string",
            "description":"listname"
        }
    },
    "required":[
        "id",
        "name"
    ]
}

Back to Top

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"
    }
  ]
}
	

Back to Top