Retrieve a program

get

/api/REST/2.0/assets/program/{id}

Retrieves the program specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Program
Type: object
Title: Program
Show Source
Nested Schema : elements
Type: array
A list of program elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the program granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CampaignElement
Type: object
Title: CampaignElement
Show Source
Nested Schema : outputTerminals
Type: array
A list of the campaign element ids within the campaign. This is a read-only property.
Show Source
Nested Schema : permissions
Type: array
The permissions for the campaign element granted to your current instance. This is a read-only property.
Show Source
Nested Schema : Position
Type: object
Title: Position
Show Source
Nested Schema : CampaignOutputTerminal
Type: object
Title: CampaignOutputTerminal
Show Source
Nested Schema : permissions
Type: array
The permissions for the campaign output terminal granted to your current instance.
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to retrieve a program using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the program with Id #40:


GET /api/REST/2.0/assets/program/40
Content-Type: application/json 
			

Response:


{
  "type": "Program",
  "currentStatus": "Draft",
  "id": "40",
  "createdAt": "1476990583",
  "createdBy": "25",
  "depth": "complete",
  "folderId": "3669",
  "name": "A Program Name",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update",
    "Activate"
  ],
  "updatedAt": "1476990583",
  "elements": [
    {
      "type": "CanvasFeeder",
      "id": "1370",
      "name": "Listener",
      "memberCount": "0",
      "position": {
        "type": "Position",
        "x": "382",
        "y": "30"
      }
    }
  ],
  "isReadOnly": "false",
  "defaultEntityType": "Contacts",
  "isMemberAllowedDuplicates": "false"
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/rest/2.0/assets/program/40
			
Back to Top