Jump to

• Request
• Response
• Examples

Retrieve a list of programs

get

/api/rest/2.0/assets/programs

Retrieves a list of programs.

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.
• lastUpdatedAt: integer
  The date and time the program was last updated.
• orderBy: string
  Specifies the field by which list results are ordered.
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultProgram

Type: object

Title: QueryResultProgram

Show Source

• elements: array elements
  Array of program fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultProgram",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of program fields.",
            "items":{
                "$ref":"#/definitions/ProgramRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of program fields.

Show Source

• Array of: object Program
  Title: Program

{
    "type":"array",
    "description":"Array of program fields.",
    "items":{
        "$ref":"#/definitions/ProgramRest20"
    }
}

Nested Schema : Program

Type: object

Title: Program

Show Source

• createdAt: string
  Read Only: true

  The date and time the program was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the program.
• currentStatus: string
  The program's current status: Active, Draft, Scheduled, Paused, or Completed.
• defaultEntityId: string
  The id of the custom object data set. Only used for custom object programs.
• defaultEntityType: string
  The program type, possible values are Contact or CustomObjectRecords.
• depth: string
  Read Only: true

  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.
• description: string
  The description of the program.
• elements: array elements
  A list of program elements.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the program.
• id: string
  Read Only: true

  Id of the program.
• isExitHistoryDisabled: string
  Program_Field_IsExitHistoryDisabled_Description
• isMemberAllowedDuplicates: string
  Whether contacts are allowed to enter the program more than once. If false, once a contact enters the program, the contact cannot enter the program again from another entry point.
• isReadOnly: string
  Whether or not the program is read only.
• name: string
  The name of the program.
• permissions: array permissions
  The permissions for the program granted to your current instance. This is a read-only property.
• runAsUserId: string
  The login id of the user to activate the program.
• scheduledFor: string
  Read Only: true

  The date the program is scheduled.
• sourceTemplateId: string
  Id of the template used to create the asset.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the program was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the program.

{
    "title":"Program",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the program."
        },
        "currentStatus":{
            "type":"string",
            "description":"The program's current status: Active, Draft, Scheduled, Paused, or Completed."
        },
        "name":{
            "type":"string",
            "description":"The name of the program."
        },
        "description":{
            "type":"string",
            "description":"The description of the program."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the program granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the program."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the program."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the program was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the program."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the program was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the program is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "elements":{
            "type":"array",
            "description":"A list of program elements.",
            "items":{
                "$ref":"#/definitions/CampaignElementRest20"
            }
        },
        "isReadOnly":{
            "type":"string",
            "description":"Whether or not the program is read only."
        },
        "runAsUserId":{
            "type":"string",
            "description":"The login id of the user to activate the program."
        },
        "isExitHistoryDisabled":{
            "type":"string",
            "description":"Program_Field_IsExitHistoryDisabled_Description"
        },
        "isMemberAllowedDuplicates":{
            "type":"string",
            "description":"Whether contacts are allowed to enter the program more than once. If false, once a contact enters the program, the contact cannot enter the program again from another entry point."
        },
        "defaultEntityType":{
            "type":"string",
            "description":"The program type, possible values are Contact or CustomObjectRecords."
        },
        "defaultEntityId":{
            "type":"string",
            "description":"The id of the custom object data set. Only used for custom object programs."
        }
    }
}

Nested Schema : elements

Type: array

A list of program elements.

Show Source

• Array of: object CampaignElement
  Title: CampaignElement

{
    "type":"array",
    "description":"A list of program elements.",
    "items":{
        "$ref":"#/definitions/CampaignElementRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the program granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the program granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : CampaignElement

Type: object

Title: CampaignElement

Show Source

• createdAt: string
  Read Only: true

  The date and time the campaign element was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the campaign element.
• currentStatus: string
  The campaign element's current status.
• depth: string
  Read Only: true

  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.
• description: string
  The description of the campaign element.
• folderId: string
  Read Only: true

  Id of the associated folder.
• id: string
  Read Only: true

  Id of the campaign element. This is a read-only property.
• memberCount: string
  Amount of members within the campaign element. This is a read-only property.
• memberErrorCount: string
  Amount of members within the campaign element in errored status. This is a read-only property.
• name: string
  Name of the campaign element. This is a read-only property.
• outputTerminals: array outputTerminals
  A list of the campaign element ids within the campaign. This is a read-only property.
• permissions: array permissions
  The permissions for the campaign element granted to your current instance. This is a read-only property.
• position: object Position
  Title: Position
• scheduledFor: string
  Read Only: true

  The date the campaign element is scheduled.
• sourceTemplateId: string
  The id of the source template.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the campaign element was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the campaign element.

{
    "title":"CampaignElement",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the campaign element. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign element's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the campaign element. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the campaign element."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the campaign element granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the campaign element."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign element was created, expressed in Unix time. "
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the campaign element."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the campaign element was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the campaign element is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "position":{
            "$ref":"#/definitions/PositionRest20",
            "description":"Array of campaign element position fields."
        },
        "outputTerminals":{
            "type":"array",
            "description":"A list of the campaign element ids within the campaign. This is a read-only property.",
            "items":{
                "$ref":"#/definitions/CampaignOutputTerminalRest20"
            }
        },
        "memberCount":{
            "type":"string",
            "description":"Amount of members within the campaign element. This is a read-only property."
        },
        "memberErrorCount":{
            "type":"string",
            "description":"Amount of members within the campaign element in errored status. This is a read-only property."
        }
    }
}

Nested Schema : outputTerminals

Type: array

A list of the campaign element ids within the campaign. This is a read-only property.

Show Source

• Array of: object CampaignOutputTerminal
  Title: CampaignOutputTerminal

{
    "type":"array",
    "description":"A list of the campaign element ids within the campaign. This is a read-only property.",
    "items":{
        "$ref":"#/definitions/CampaignOutputTerminalRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the campaign element granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the campaign element granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Position

Type: object

Title: Position

Show Source

• type: string
  The campaign element's type. This is a read-only property.
• x: string
  The position of the campaign element on the x axis.
• y: string
  The position of the campaign element on the y axis.

{
    "title":"Position",
    "properties":{
        "type":{
            "type":"string",
            "description":"The campaign element's type. This is a read-only property."
        },
        "x":{
            "type":"string",
            "description":"The position of the campaign element on the x axis."
        },
        "y":{
            "type":"string",
            "description":"The position of the campaign element on the y axis."
        }
    }
}

Nested Schema : CampaignOutputTerminal

Type: object

Title: CampaignOutputTerminal

Show Source

• connectedId: string
  The connected id of the campaign output terminal. This is a read-only property.
• connectedType: string
  The campaign output terminal's connection type. This is a read-only property.
• createdAt: string
  Read Only: true

  The date and time the campaign output terminal was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the campaign output terminal.
• currentStatus: string
  The campaign output terminal's current status.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. For more information, see Request depth.
• description: string
  The description of the campaign output terminal.
• folderId: string
  Read Only: true

  Id of the associated folder.
• id: string
  Read Only: true

  Id of the campaign output terminal. This is a read-only property.
• name: string
  Name of the campaign output terminal.
• permissions: array permissions
  The permissions for the campaign output terminal granted to your current instance.
• scheduledFor: string
  Read Only: true

  The date the campaign output terminal is scheduled.
• sourceTemplateId: string
  The id of the source template.
• terminalType: string
  The campaign output terminal type. This is a read-only property.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the campaign output terminal.

{
    "title":"CampaignOutputTerminal",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the campaign output terminal. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The campaign output terminal's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the campaign output terminal."
        },
        "description":{
            "type":"string",
            "description":"The description of the campaign output terminal."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the campaign output terminal granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the campaign output terminal."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the campaign output terminal was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the campaign output terminal."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the campaign output terminal was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the campaign output terminal is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "terminalType":{
            "type":"string",
            "description":"The campaign output terminal type. This is a read-only property."
        },
        "connectedType":{
            "type":"string",
            "description":"The campaign output terminal's connection type. This is a read-only property."
        },
        "connectedId":{
            "type":"string",
            "description":"The connected id of the campaign output terminal. This is a read-only property."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the campaign output terminal granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the campaign output terminal granted to your current instance.",
    "items":{
        "type":"string"
    }
}

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 list of programs using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the first 2 programs in your database:

GET /api/REST/2.0/assets/programs?count=2
Content-Type: application/json 
			

Response:

{
  "elements": [
    {
      "type": "Program",
      "currentStatus": "Draft",
      "id": "40",
      "createdAt": "1476990583",
      "createdBy": "25",
      "depth": "minimal",
      "folderId": "3669",
      "name": "A Program Name",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update",
        "Activate"
      ],
      "updatedAt": "1476990583",
      "defaultEntityType": "Contacts"
    },
    {
      "type": "Program",
      "currentStatus": "Draft",
      "id": "25",
      "createdAt": "1472737496",
      "createdBy": "13",
      "depth": "minimal",
      "folderId": "3669",
      "name": "Another Program Name",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update",
        "Activate"
      ],
      "updatedAt": "1472737496",
      "defaultEntityId": "1",
      "defaultEntityType": "CustomObjectRecords"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 36
}
			

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/programs?count=2
			

Back to Top